Include README as crate doc #4
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
This change makes two main profits: * The entry point in the doc site of the crate always will be its README which will exclude the need of repeting the same things inside the `lib.rs` and README itself. * After inclusion of the README as a doc, all the code inside it will be evaludated as Rust _doc test_ which will keep the code examples up-to-date.
|
After running 
|
|
Also, the entry page of the doc-site after running the 
|
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.
This change makes two main profits:
The entry point in the doc site of the crate always will be its README which will exclude the need of repeting the same things inside the
lib.rsand README itself.After inclusion of the README as a doc, all the code inside it will be evaludated as Rust doc test which will keep the code examples up-to-date.