This repository was archived by the owner on Jun 2, 2024. It is now read-only.
Picking the low-hanging documentation fruit #265
Merged
+133
−80
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
give more warnings about possible misuse of the type
Making the paths to the types private forces rustdoc to render the structs inline in the crate root. This is simpler to see when first reading the API doc
Explain more of what ZIP is intended for, and begin to explain what the crate can be used for.
zamazan4ik
reviewed
Jan 26, 2022
| //! | ||
| //! | | Reading | Writing | | ||
| //! | ------- | ------ | ------- | | ||
| //! | Deflate | ✅ [->](`crate::ZipArchive::by_name`) | ✅ [->](`crate::write::FileOptions::compression_method`) | |
There was a problem hiding this comment.
I think we need to add here more features.
zamazan4ik
approved these changes
Mar 8, 2022
|
I am going to merge it. Further documentation improvements will be created in other PRs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I've started writing explanations for different parts of the crate as I come across them. This can probably be merged at any time, but I'll keep expanding on it.