libcnb-test: Overhaul the README and crate docs #478
Merged
Conversation
This file contains hidden or 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
806dbbc to
800971d
Compare
|
Rendered version of the README (likely easier to review than the diff): |
Whilst the individual libcnb-test APIs already had rustdocs and examples, discovering what features existed and where in the modules/types hierarchy to look for these was hard for users new to the crate. Now, the README covers: - what the test framework does - prerequisites for the host machine - examples for all common use-cases - tips/best practices Some rustdocs for individual APIs have been updated to match the style used in the README for consistency. Lastly, the "experimental" label has been removed, since the crate is now mostly complete. GUS-W-11468003.
800971d to
ba60b05
Compare
colincasey
approved these changes
Jul 21, 2022
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.
Whilst the individual libcnb-test APIs already had rustdocs and examples, discovering what features existed and where in the modules/types hierarchy to look for these was hard for users new to the crate.
Now, the README covers:
Some rustdocs for individual APIs have been updated to match the style used in the README for consistency.
Lastly, the "experimental" label has been removed, since the crate is now mostly complete.
GUS-W-11468003.