Skip to content
This repository has been archived by the owner on Jan 19, 2021. It is now read-only.

Base trie code documentation and function clustering #125

Merged
merged 4 commits into from
Aug 26, 2020

Conversation

holgerd77
Copy link
Member

This PR targets to make the BaseTrie code from MPT more readable and do some basic clean up.

Following changes:

  • Improved constructor documentation
  • Removed redundant @param type documentation on all files
  • Made Trie.setRoot() private
  • Reordering of BaseTrie functionality to get to more intuitive function clusters
  • Various code doc additions
  • Explicitly defined (so: not inlined) onFound functions in Trie for better code readability
  • Documentation rebuild

It might be easiest to review this PR by going along commit-by-commit.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.008%) to 94.704% when pulling 010c2cf on base-trie-code-docs-and-base-refactoring into e2c3cd5 on master.

Copy link
Contributor

@ryanio ryanio left a comment

Choose a reason for hiding this comment

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

nice cleanup, LGTM!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants