Skip to content

Commit dfd3954

Browse files
committed
output_to_graphviz doc improvement
1 parent 9fc4396 commit dfd3954

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

pyrtl/visualization.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,11 @@ def output_to_graphviz(file, block=None, namer=_graphviz_default_namer,
311311
:param maintain_arg_order: If True, will add ordering constraints so that that incoming edges
312312
are ordered left-to-right for nets where argument order matters (e.g. '<'). Keeping this
313313
as False results in a cleaner, though less visually precise, graphical output.
314+
315+
The file written by the this function should be a directed graph in the format expected
316+
by the graphviz package (https://graphviz.org/), specifically in the "dot" format. Once
317+
graphviz is installed, the resulting graph file can be rendered to a .png file with
318+
"dot -Tps output.dot > output.ps".
314319
"""
315320
print(block_to_graphviz_string(block, namer, split_state, maintain_arg_order), file=file)
316321

0 commit comments

Comments
 (0)