Skip to content

Commit 39bb141

Browse files
authored
Misc update docstring (#420)
docs: update
1 parent dee9d86 commit 39bb141

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

bigtree/tree/construct/dataframes.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ def dataframe_to_tree_by_relation(
482482
allow_duplicates: bool = False,
483483
node_type: type[T] = _node.Node, # type: ignore[assignment]
484484
) -> T:
485-
"""Construct tree from pandas DataFrame using parent and child names, return root of tree.
485+
"""Construct tree from pandas DataFrame using adjacency list (parent and child names), return root of tree.
486486
487487
Root node is inferred when parent name is empty, or when name appears in parent column but not in child column.
488488
@@ -714,7 +714,7 @@ def polars_to_tree_by_relation(
714714
allow_duplicates: bool = False,
715715
node_type: type[T] = _node.Node, # type: ignore[assignment]
716716
) -> T:
717-
"""Construct tree from polars DataFrame using parent and child names, return root of tree.
717+
"""Construct tree from polars DataFrame using adjacency list (parent and child names), return root of tree.
718718
719719
Root node is inferred when parent name is empty, or when name appears in parent column but not in child column.
720720

bigtree/tree/construct/lists.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ def list_to_tree_by_relation(
8989
allow_duplicates: bool = False,
9090
node_type: type[T] = node.Node, # type: ignore[assignment]
9191
) -> T:
92-
"""Construct tree from list of tuple containing parent-child names.
92+
"""Construct tree from an adjacency list; list of tuple containing parent-child names.
9393
9494
Root node is inferred when parent is empty, or when name appears as parent but not as child.
9595

0 commit comments

Comments
 (0)