Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstring comment to prefer node_name over name #316

Merged
merged 5 commits into from
Nov 3, 2024
Merged

Conversation

kayjan
Copy link
Owner

@kayjan kayjan commented Nov 3, 2024

Description

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 Nov 3, 2024
@kayjan kayjan changed the title Fix docstring Add docstring comment to prefer node_name over name Nov 3, 2024
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

Benchmark suite Current: ebfda72 Previous: 63961b2 Ratio
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10 15798.874014635488 iter/sec (stddev: 0.000015972481526257916) 16096.709027711444 iter/sec (stddev: 0.0000037561512209419424) 1.02
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100 700.9019416456063 iter/sec (stddev: 0.000019526612339931073) 687.11611252235 iter/sec (stddev: 0.000004356909141702008) 0.98
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000 12.29620749855078 iter/sec (stddev: 0.0023283269851229163) 12.136155295675252 iter/sec (stddev: 0.0028796379898676306) 0.99
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10 66.72213633712026 iter/sec (stddev: 0.003932865832983906) 71.65650591146239 iter/sec (stddev: 0.002537886918562786) 1.07
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10_no_assertions 21606.088595506684 iter/sec (stddev: 0.00000393257436413092) 11350.370617744285 iter/sec (stddev: 0.00006490625068357492) 0.53
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100_no_assertions 1586.4612664674403 iter/sec (stddev: 0.0000605938185583214) 1775.5115936875593 iter/sec (stddev: 0.00000603734840781264) 1.12
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000_no_assertions 108.30714971887613 iter/sec (stddev: 0.004316849705326227) 127.47284735931528 iter/sec (stddev: 0.002290996979665179) 1.18
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10_no_assertions 91.07439051389136 iter/sec (stddev: 0.0036758761465116477) 99.44272396930072 iter/sec (stddev: 0.002352970222132825) 1.09

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

@kayjan kayjan merged commit 4aa928b into master Nov 3, 2024
6 checks passed
@kayjan kayjan deleted the bugfix/docstring branch November 3, 2024 16:30
Copy link
Contributor

github-actions bot commented Nov 3, 2024

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.utils 100% 100% 0
Summary 100% (2379 / 2379) 100% (1006 / 1006) 0

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