📝 Add c3-linearization printer docs

docs/static-analysis/printers/c3-linearization.md

@@ -0,0 +1,16 @@
+# C3 linearization printer
+
+Prints the [C3 linearization](https://docs.soliditylang.org/en/latest/contracts.html#multiple-inheritance-and-linearization) of a contract.
+
+## Example
+
+<div>
+--8<-- "docs/static-analysis/printers/c3-linearization.svg"
+</div>
+
+## Parameters
+
+| Command-line name | TOML name                 | Type   | Default value | Description                                                              |
+|-------------------|---------------------------|--------|---------------|--------------------------------------------------------------------------|
+| `--interfaces`    | <nobr>`interfaces`</nobr> | `bool` | `False`       | Whether to include interfaces in the output.                             |
+| `--verbose`       | <nobr>`verbose`</nobr>    | `bool` | `False`       | Whether to print more verbose input with base contracts and constructor. |

mkdocs.yml

@@ -90,6 +90,7 @@ nav:
             - Unused modifier: 'static-analysis/detectors/unused-modifier.md'
         - Printers:
             - ABI: 'static-analysis/printers/abi.md'
+            - C3 linearization: 'static-analysis/printers/c3-linearization.md'
             - Control flow graph: 'static-analysis/printers/control-flow-graph.md'
             - Imports graph: 'static-analysis/printers/imports-graph.md'
             - Inheritance graph: 'static-analysis/printers/inheritance-graph.md'

wake_printers/c3_linearization.py

@@ -90,5 +90,8 @@ def add_contract_to_tree(parent_node, n, index):
         help="Show inheritance and constructors",
     )
     def cli(self, interfaces: bool, verbose: bool) -> None:
+        """
+        Print the C3 linearization of contracts.
+        """
         self._interfaces = interfaces
         self._verbose = verbose