Skip to content

Commit

Permalink
docs(python): Fix link to GraphViz download
Browse files Browse the repository at this point in the history
  • Loading branch information
rodrigogiraoserrao committed Nov 14, 2024
1 parent 5f11dd9 commit 7032d2e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
7 changes: 5 additions & 2 deletions py-polars/polars/expr/meta.py
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,10 @@ def show_graph(
figsize: tuple[float, float] = (16.0, 12.0),
) -> str | None:
"""
Format the expression as a GraphViz.
Format the expression as a Graphviz graph.
Note that Graphviz must be installed to render the visualization (if not
already present, you can download it here: `<https://graphviz.org/download>`_).
Parameters
----------
Expand All @@ -413,7 +416,7 @@ def show_graph(
raw_output
Return dot syntax. This cannot be combined with `show` and/or `output_path`.
figsize
Passed to matplotlib if `show` == True.
Passed to matplotlib if `show == True`.
Examples
--------
Expand Down
12 changes: 6 additions & 6 deletions py-polars/polars/lazyframe/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -1138,8 +1138,8 @@ def show_graph(
"""
Show a plot of the query plan.
Note that graphviz must be installed to render the visualization (if not
already present you can download it here: <https://graphviz.org/download>`_).
Note that Graphviz must be installed to render the visualization (if not
already present, you can download it here: `<https://graphviz.org/download>`_).
Parameters
----------
Expand All @@ -1152,7 +1152,7 @@ def show_graph(
raw_output
Return dot syntax. This cannot be combined with `show` and/or `output_path`.
figsize
Passed to matplotlib if `show` == True.
Passed to matplotlib if `show == True`.
type_coercion
Do type coercion optimization.
predicate_pushdown
Expand All @@ -1168,11 +1168,11 @@ def show_graph(
comm_subexpr_elim
Common subexpressions will be cached and reused.
cluster_with_columns
Combine sequential independent calls to with_columns
Combine sequential independent calls to with_columns.
collapse_joins
Collapse a join and filters into a faster join
Collapse a join and filters into a faster join.
streaming
Run parts of the query in a streaming fashion (this is in an alpha state)
Run parts of the query in a streaming fashion (this is in an alpha state).
Examples
--------
Expand Down

0 comments on commit 7032d2e

Please sign in to comment.