Skip to content

Commit

Permalink
More feedback rework
Browse files Browse the repository at this point in the history
  • Loading branch information
brson committed Mar 27, 2019
1 parent 1bfb08b commit f4afd81
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
4 changes: 2 additions & 2 deletions rust/plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ or [submit pull requests][spr] with improvements. _Each accepted pull request
counts toward extra credit during final evaluation_. Pull requests to any other
project used during this course count as well. This is an opportunity to gain
experience contributing to an open-source Rust project. Make this a better
course for the next to take it than it was for you. That is how open source
projects evolve.
course for the next student to take it than it was for you. That is how open
source projects evolve.

[si]: https://github.com/pingcap/talent-plan/issues/new
[spr]: https://github.com/pingcap/talent-plan/compare
Expand Down
7 changes: 5 additions & 2 deletions rust/projects/tools/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ You have implemented the project's functionality, but there are still a few more
things to do before it is a polished piece of Rust software, ready for
contributions or publication.

First, public items should have doc comments.
First, public items should generally have doc comments.

Doc comments are displayed in a crate's API documentation. API documentation can
be generated with the command, `cargo doc`, which will render them as HTML to
Expand All @@ -347,7 +347,10 @@ an `index.html`. Your crate's documentation will be located at
information gathered from the type signature. They explain why and how one would
use a function, what the return value is on both success and failure, error and
panic conditions. The library you have written is very simple so the
documentation can be simple as well.
documentation can be simple as well. If you truly cannot think of anything
useful to add through doc comments then it can be ok to not add a doc comment
(this is a matter of preference). With no doc comments it should be obvious how
the type or function is used from the name and type signature alone.

Doc comments contain examples, and those examples can be tested with `cargo test
--doc`.
Expand Down

0 comments on commit f4afd81

Please sign in to comment.