Skip to content

Improve docs#439

Merged
kayjan merged 2 commits intomasterfrom
docs/improve
Feb 17, 2026
Merged

Improve docs#439
kayjan merged 2 commits intomasterfrom
docs/improve

Conversation

@kayjan
Copy link
Owner

@kayjan kayjan commented Feb 17, 2026

Description

Make docs more succinct, and up-to-date

Testing

Additional notes

Checklist

I have read through the contributing guidelines and ensured that

  • I have added a descriptive title for this pull request.
  • I have followed the convention and standards, and my code is checked for style and correctness.
  • I have added test cases, and unit tests pass with 100% code coverage.
  • I have updated the documentation and code docstrings.

Checklist (for reviewer)

  • I have added label (breaking / enhancement / bug / documentation) to this pull request, if applicable.
  • I will ensure this change is captured in the CHANGELOG.md file.

@kayjan kayjan added the documentation Improvements or additions to documentation label Feb 17, 2026
@github-actions
Copy link
Contributor

Code Coverage

Package Line Rate Branch Rate Complexity Health
bigtree 100% 100% 0
bigtree.binarytree 100% 100% 0
bigtree.dag 100% 100% 0
bigtree.node 100% 100% 0
bigtree.tree 100% 100% 0
bigtree.tree.construct 100% 100% 0
bigtree.tree.export 100% 100% 0
bigtree.utils 100% 100% 0
Summary 100% (3186 / 3186) 100% (1159 / 1160) 0

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmark

Details
Benchmark suite Current: 070715d Previous: beecc6b Ratio
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10 19581.043982965322 iter/sec (stddev: 0.0000052810977063185234) 18403.47972990415 iter/sec (stddev: 0.0000070397429813627525) 0.94
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100 550.3849943034701 iter/sec (stddev: 0.00003788720560018722) 388.2823681014769 iter/sec (stddev: 0.000012195753498541788) 0.71
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000 16.187252662522585 iter/sec (stddev: 0.0003403713645558004) 12.901185521416455 iter/sec (stddev: 0.0030098746845965184) 0.80
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10 91.69131829784249 iter/sec (stddev: 0.00015558406866795447) 86.61513646368432 iter/sec (stddev: 0.00010797810462619051) 0.94
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10_no_assertions 46171.888707239545 iter/sec (stddev: 0.000002965322998755052) 42153.18467377684 iter/sec (stddev: 0.000003163171474916069) 0.91
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10_no_assertions_config 35624.52463482244 iter/sec (stddev: 0.000013165267604799872) 33632.38125620018 iter/sec (stddev: 0.000011086232248073238) 0.94
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100_no_assertions 3664.5466653467142 iter/sec (stddev: 8.57366972033756e-7) 2938.0452920197217 iter/sec (stddev: 0.000001709430643021046) 0.80
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100_no_assertions_config 2683.9617583766767 iter/sec (stddev: 0.00013312466024188456) 2182.2880482733754 iter/sec (stddev: 0.00016696240672713696) 0.81
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000_no_assertions 157.12953255848882 iter/sec (stddev: 0.0045669174528080725) 114.86691000034456 iter/sec (stddev: 0.006813304550574504) 0.73
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000_no_assertions_config 307.28860610412335 iter/sec (stddev: 0.0002054187625756158) 246.6338730759631 iter/sec (stddev: 0.00020677301348345607) 0.80
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10_no_assertions 209.5212818989613 iter/sec (stddev: 0.00016540267058826183) 199.28419309961433 iter/sec (stddev: 0.00008436102097663251) 0.95
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10_no_assertions_config 126.87678117159261 iter/sec (stddev: 0.004785093906640255) 99.52576124057424 iter/sec (stddev: 0.007413951738947604) 0.78

This comment was automatically generated by workflow using github-action-benchmark.

@kayjan kayjan merged commit 711f8cb into master Feb 17, 2026
5 checks passed
@kayjan kayjan deleted the docs/improve branch February 17, 2026 06:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments