Skip to content

Documentation improvements#452

Merged
kayjan merged 12 commits into
masterfrom
feat/enhance-mypy
May 9, 2026
Merged

Documentation improvements#452
kayjan merged 12 commits into
masterfrom
feat/enhance-mypy

Conversation

@kayjan
Copy link
Copy Markdown
Owner

@kayjan kayjan commented May 9, 2026

Description

  • Documentation: Enumerate demonstration page, fix url links, include query examples
  • Feature: Expose get_common_ancestors method to BaseNode

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 May 9, 2026
@kayjan kayjan enabled auto-merge (squash) May 9, 2026 17:07
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 9, 2026

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% (3244 / 3244) 100% (1164 / 1164) 0

Copy link
Copy Markdown
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: 0a0b304 Previous: 91063ab Ratio
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10 19120.970732662736 iter/sec (stddev: 0.00000505708627960102) 18332.292976244313 iter/sec (stddev: 0.00000426265180976833) 0.96
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100 400.1451886800706 iter/sec (stddev: 0.000066303847237925) 441.01443021288776 iter/sec (stddev: 0.00008243309433773081) 1.10
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000 13.489546636005038 iter/sec (stddev: 0.0004310415457903307) 13.141383055897187 iter/sec (stddev: 0.0017176958732619378) 0.97
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10 85.71363857632453 iter/sec (stddev: 0.00023078303636891277) 81.57132474279092 iter/sec (stddev: 0.00003775511805258042) 0.95
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10_no_assertions 37919.93963083572 iter/sec (stddev: 0.000004644913734648348) 37089.374266022205 iter/sec (stddev: 0.000004268237952545832) 0.98
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10_no_assertions_config 28306.239544770997 iter/sec (stddev: 0.000021173746875148203) 27359.51912966708 iter/sec (stddev: 0.00001884291079667236) 0.97
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100_no_assertions 155.28689490647463 iter/sec (stddev: 0.008652903653009542) 176.50684845246116 iter/sec (stddev: 0.007493689766499106) 1.14
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100_no_assertions_config 3049.116076496191 iter/sec (stddev: 1.4142187036815178e-9) 3033.234697605989 iter/sec (stddev: 0.000008105211477979433) 0.99
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000_no_assertions 249.01481645618736 iter/sec (stddev: 0.00011294305488684074) 245.61950507712658 iter/sec (stddev: 0.000015929984409965706) 0.99
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000_no_assertions_config 235.05664683012677 iter/sec (stddev: 0.00040854444856543463) 232.06726330380621 iter/sec (stddev: 0.00033871107783286223) 0.99
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10_no_assertions 205.05625246663155 iter/sec (stddev: 0.00033710028858769796) 168.56562728899877 iter/sec (stddev: 0.0003417723552229811) 0.82
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10_no_assertions_config 87.5544504958099 iter/sec (stddev: 0.008735227145801694) 89.22575617088076 iter/sec (stddev: 0.007455386994244151) 1.02

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

@kayjan kayjan merged commit 74125d2 into master May 9, 2026
5 checks passed
@kayjan kayjan deleted the feat/enhance-mypy branch May 9, 2026 17:08
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