Improve main module (lib.rs) docs + re-export more types at the crate root #444
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
|
I like what you have so far, it is very clear and if we add some examples of high-level usage and low level usage we should be in a pretty good spot |
nicoburns
force-pushed
the
doc/improve-high-level-docs
branch
from
86f7401
to
914af83
Compare
nicoburns
force-pushed
the
doc/improve-high-level-docs
branch
from
914af83
to
c403178
Compare
nicoburns
force-pushed
the
doc/improve-high-level-docs
branch
from
c403178
to
123439b
Compare
nicoburns
force-pushed
the
doc/improve-high-level-docs
branch
5 times, most recently
from
68d063a
to
b4dfd5d
Compare
nicoburns
force-pushed
the
doc/improve-high-level-docs
branch
from
b4dfd5d
to
b37e890
Compare
nicoburns
force-pushed
the
doc/improve-high-level-docs
branch
from
925eab3
to
587a390
Compare
nicoburns
changed the title
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.
Objective
Make it easier to get started with Taffy by providing a high-level introduction to the API
Feedback wanted
Any feedback on the content of the documentation itself is welcome