Skip to content

Commit f465398

Browse files
authored
Enhance docs (#401)
* feat: nested_key_dict to tree to support child_key=None * feat: tree to nested_key_dict to support child_key=None * docs: update docs * docs: update CHANGELOG
1 parent 93dcaba commit f465398

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

CHANGELOG.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,17 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [Unreleased]
8+
### Changed:
9+
- Docs: Enhanced docs.
10+
711
## [0.30.1] - 2025-09-10
812
### Added:
913
- Tree Construct: `nested_dict_key_to_tree` to support child_key=None.
1014
- Tree Export: `tree_to_nested_dict_key` to support child_key=None.
11-
### Changed
15+
### Changed:
1216
- Misc: Some code refactoring, enhance assemble_attributes.
13-
### Fixed
17+
### Fixed:
1418
- Test: Test for `tree_to_nested_dict_key` for BinaryNode.
1519
- Error: Check and throw error for `dataframe_to_dag`, previously this error will not have been found out.
1620

bigtree/tree/construct/strings.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,17 @@ def str_to_tree(
111111
112112
Examples:
113113
>>> from bigtree import str_to_tree
114-
>>> tree_str = 'a\n├── b\n│ ├── d\n│ └── e\n│ ├── g\n│ └── h\n└── c\n └── f'
115-
>>> root = str_to_tree(tree_str, tree_prefix_list=["├──", "└──"])
114+
>>> tree_str = (
115+
... 'a\n'
116+
... '├── b\n'
117+
... '│ ├── d\n'
118+
... '│ └── e\n'
119+
... '│ ├── g\n'
120+
... '│ └── h\n'
121+
... '└── c\n'
122+
... ' └── f'
123+
... )
124+
>>> root = str_to_tree(tree_str)
116125
>>> root.show()
117126
a
118127
├── b

0 commit comments

Comments
 (0)