✨ Add modifiers printer

Ackee-Blockchain · Nov 27, 2023 · 4e29bc7 · 4e29bc7
1 parent 2540708
commit 4e29bc7
Show file tree

Hide file tree

Showing 5 changed files with 335 additions and 0 deletions.
diff --git a/docs/static-analysis/printers/modifiers.md b/docs/static-analysis/printers/modifiers.md
@@ -0,0 +1,17 @@
+# Modifiers printer
+
+Prints modifiers with their usages.
+
+## Example
+
+<div>
+--8<-- "docs/static-analysis/printers/modifiers.svg"
+</div>
+
+## Parameters
+
+| Command-line name                                                         | TOML name                      | Type        | Default value | Description                                                     |
+|---------------------------------------------------------------------------|--------------------------------|-------------|---------------|-----------------------------------------------------------------|
+| `--name` (multiple)                                                       | <nobr>`names`</nobr>           | `List[str]` | `[]`          | Modifier names.                                                 |
+| <nobr>`--canonical-names`</nobr>/<br/><nobr>`--no-canonical-names`</nobr> | <nobr>`canonical_names`</nobr> | `bool`      | `True`        | Whether to print (full) canonical names instead of local names. |
+| <nobr>`--code-snippets`</nobr>/<br/><nobr>`--no-code-snippets`</nobr>     | <nobr>`code_snippets`</nobr>   | `bool`      | `True`        | Whether to print modifier source code snippets.                 |