Updated docs for the new feature

caleb531 · Oct 13, 2023 · e6b97c7 · e6b97c7
1 parent 587500d
commit e6b97c7
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/pda/class-pda.md b/docs/pda/class-pda.md
@@ -5,6 +5,20 @@
 The `PDA` class is an abstract base class from which all pushdown automata
 inherit. It can be found under `automata/pda/pda.py`.
 
+The `PDA` class has the following abstract methods:
+
+## PDA.show_diagram(self, input_str = None, path = None):
+
+Constructs and returns a pygraphviz `AGraph` corresponding to this PAD. If `input_str` is
+set, then shows execution of the PDA on `input_str`. If `path` is
+set, then an image of the diagram is written to the corresponding file. Other
+customization options are available, see function signature for more
+details.
+
+```python
+pda.show_diagram(path='./pda.png')
+```
+
 ## Subclasses
 
 ### [DPDA (Deterministic Pushdown Automaton)](class-dpda.md)