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.

Sign up for GitHub

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

Jump to bottom

Improve docs and tests #35

Merged
merged 5 commits into from
Aug 3, 2019
Merged

Improve docs and tests #35

merged 5 commits into from
Aug 3, 2019

Conversation

lo48576
Copy link
Contributor

@lo48576 lo48576 commented Aug 3, 2019 •
edited
Loading

  • Applied rustfmt formatter.
  • Improved documentation.
    • Use RFC 505 convention (similar to std docs).
    • Use more links.
    • Add "examples" sections and "failures" sections to many methods.
  • Add more tests.
    • Add tests for insertion failures.
    • Code examples in documentation also works as tests.
  • Move impls to appropriate module (overlooked in Split code into modules #33).

This does not change any interfaces or behavior.

@lo48576
Apply rustfmt
39925d1
@lo48576
Move impl for Node<T> into node module
50ef207 
This should be done in saschagrunert#33 but overlooked.
@lo48576
Improve doc comments
9751061 
* 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
@lo48576
Add examples sections to many methods
410efa5 
They are not only simple usage guide, but also tests.
@lo48576
Add tests for insertion failure
d84f8f3
saschagrunert
saschagrunert approved these changes Aug 3, 2019
View reviewed changes
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.

Neat, thanks!

@saschagrunert saschagrunert merged commit a65d6a3 into saschagrunert:master Aug 3, 2019
@lo48576 lo48576 deleted the feature/docs-and-tests branch August 4, 2019 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@saschagrunert saschagrunert saschagrunert approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lo48576 @saschagrunert