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

Split code into modules #33

Merged
merged 7 commits into from
Jul 31, 2019

Conversation

lo48576
Copy link
Contributor

@lo48576 lo48576 commented Jul 31, 2019

This is tiny refactoring.
Split code into modules arena, error, id, node, and traverse.
This change may keep things simple and make it easy to find and change relevant code.

Types are exported from top-level, and modules itself are private.
So public items are not changed and this is non-breaking change.

Copy link
Owner

@saschagrunert saschagrunert left a comment

Choose a reason for hiding this comment

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

LGTM :), I like it.

@saschagrunert saschagrunert merged commit ddb565f into saschagrunert:master Jul 31, 2019
@lo48576 lo48576 deleted the feature/modularize branch August 1, 2019 04:26
lo48576 added a commit to lo48576/indextree that referenced this pull request Aug 1, 2019
This should be done in saschagrunert#33 but there was a mistake.
lo48576 added a commit to lo48576/indextree that referenced this pull request Aug 2, 2019
This should be done in saschagrunert#33 but there was a mistake.
lo48576 added a commit to lo48576/indextree that referenced this pull request Aug 2, 2019
This should be done in saschagrunert#33 but there was a mistake.
lo48576 added a commit to lo48576/indextree that referenced this pull request Aug 3, 2019
This should be done in saschagrunert#33 but overlooked.
@lo48576 lo48576 mentioned this pull request Aug 3, 2019
saschagrunert pushed a commit that referenced this pull request Aug 3, 2019
* Apply rustfmt

* Move impl for `Node<T>` into `node` module

This should be done in #33 but overlooked.

* Improve doc comments

* Use third person singular present indicative form for method summary.
* Reword and fix some comments.
* Add links if typenames and methods are used in doc comments.

See also: [rfc-0505].

[rfc-0505]: https://rust-lang.github.io/rfcs/0505-api-comment-conventions.html

* Add examples sections to many methods

They are not only simple usage guide, but also tests.

* Add tests for insertion failure
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants