Corrected docstring of factory

cad-polito-it · Oct 10, 2024 · 3231ffa · 3231ffa
1 parent b3ca434
commit 3231ffa
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/testcrush/grammars/transformers.py b/src/testcrush/grammars/transformers.py
@@ -319,7 +319,13 @@ class TraceTransformerFactory:
     """
     Factory pattern for trace transformers and the corresponding grammars.
 
-    To be used as ``transformer, grammar = TraceTransformerFactory("ProcessorString")``
+    To be used as:
+
+    .. code-block:: python
+
+        factory = TraceTransformerFactory()
+        transformer, grammar = TraceTransformerFactory("ProcessorString")
+
     """
     _current_directory = pathlib.Path(__file__).parent
     _transformers = {