Skip to content

Commit

Permalink
docs: update docstring for new parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
kayjan committed Nov 3, 2024
1 parent 574fe57 commit 616c05c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions bigtree/tree/export.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ def print_tree(
"""Print tree to console, starting from `tree`.
Accepts kwargs for print() function.
- Able to have alias for node name if alias attribute is present, else it falls back to node_name, using `alias`
- Able to select which node to print from, resulting in a subtree, using `node_name_or_path`
- Able to customize for maximum depth to print, using `max_depth`
- Able to choose which attributes to show or show all attributes, using `attr_name_filter` and `all_attrs`
Expand Down Expand Up @@ -1592,6 +1593,7 @@ def tree_to_mermaid(
Args:
tree (Node): tree to be exported
title (str): title, defaults to None
theme (str): theme or colour scheme, defaults to None
rankdir (str): layout direction, defaults to 'TB' (top to bottom), can be 'BT' (bottom to top),
'LR' (left to right), 'RL' (right to left)
line_shape (str): line shape or curvature, defaults to 'basis'
Expand Down

0 comments on commit 616c05c

Please sign in to comment.