Skip to content

Commit 802ccd2

Browse files
authored
Clearer documentation for pytask dag -o. (#376)
1 parent fe5deca commit 802ccd2

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/source/tutorials/visualizing_the_dag.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,18 @@ $ pytask dag
2020

2121
It generates a `dag.pdf` in the current working directory.
2222

23-
There are ways to customize the visualization.
24-
25-
1. You can change the graph's layout by using the {option}`pytask dag --layout` option.
26-
Its default is set to `dot` and produces a hierarchical structure. graphviz supports
27-
other layouts, which are listed [here](https://graphviz.org/docs/layouts/).
28-
1. Using the {option}`pytask dag --output-path` option, you can provide a file name for
29-
the graph. The file extension changes the output format as supported by
30-
[pygraphviz](https://github.com/pygraphviz/pygraphviz).
23+
If you do not want to generate a PDF, use {option}`pytask dag --output-path` or,
24+
shorter, {option}`pytask dag -o` to choose a different format inferred from the
25+
file-ending. Select any format supported by
26+
[graphviz](https://graphviz.org/docs/outputs/).
27+
28+
```console
29+
$ pytask dag -o dag.png
30+
```
31+
32+
You can change the graph's layout by using the {option}`pytask dag --layout` option. Its
33+
default is set to `dot` and produces a hierarchical structure. graphviz supports other
34+
layouts, which are listed [here](https://graphviz.org/docs/layouts/).
3135

3236
## Programmatic Interface
3337

0 commit comments

Comments
 (0)