Add crate documentation and update README #38
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make sure that we won't delete any useful examples when I will rewrite the README in the next commit
- Add docs.rs badge - Remove all old examples and explanation (this is mostly in the crate docs now) - Add a new simple example (the same as in the crate docs) - Add license section
KodrAus
reviewed
Oct 15, 2018
There was a problem hiding this comment.
Sorry @LukasKalbertodt I've had a review sitting here for a few days, but must've forgotten to actually submit it!
README.md
Outdated
| #[auto_impl(Fn)] | ||
| trait MyTrait<'a, T> { | ||
| fn execute<'b>(&'a self, arg1: &'b T, arg2: &'static str) -> Result<(), String>; | ||
| // This will generate two additional impl blocks: one `for &T` and one |
There was a problem hiding this comment.
Nitpick: the ` here is covering the for
src/lib.rs
Outdated
| //! | ||
| //! # Basic syntax and supported types | ||
| //! | ||
| //! You have to annotate your trait with the `#[auto_impl(...)]` attribute. You |
There was a problem hiding this comment.
Wording wise it might be better to use can rather than have here, so it reads a bit easier.
src/lib.rs
Outdated
| //! | ||
| //! // All these calls work, as the `#[auto_impl]` attribute generated four | ||
| //! // impls for all those proxy types | ||
| //! require_animal(Dog("Niko".into())); |
There was a problem hiding this comment.
:) Not sure about the insinuation here...
There was a problem hiding this comment.
Yeah, I worried about that, too :/
Like, it's obviously meant in a funny/nice way (everyone likes dogs?), but gotta take care not to make others feel strange/bad. Will change all names to "Doggo" ^_^
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #16
Closes #7
As discussed, most documentation is in the crate docs and the README is shorter now. The README only shows one simple example and refers to
examples/and the crate docs. All old examples from the old README were added as compile-pass tests.A note on reviewing: I'm not a native speaker and I'm a perfectionist. So please tell me everything that can be improved. Formulations and stuff that is not common in English and might confuse people should be rewritten. So please don't withhold any comments regarding anything :P