Add inner-code documentation for crate rusty_vault #52
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 is important for developers and it's a 'must' for publish this crate to crates.io
Build inner code document only for rusty_vault crate and rvault binary, so option --no-deps is passed to cargo doc command.
wa5i
approved these changes
Apr 25, 2024
wa5i
pushed a commit
to wa5i/RustyVault
that referenced
this pull request
Dec 25, 2024
* Add inner-code documentation This is important for developers and it's a 'must' for publish this crate to crates.io * Add documentation build in CI Build inner code document only for rusty_vault crate and rvault binary, so option --no-deps is passed to cargo doc command.
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 is important for developers and it's a 'must' for publish this crate to crates.io
The
rusty_vaultcrate has many modules inside. This pull request guarantees all top level modules are documented. For sub modules nested in the code, not all of them are covered yet. That consumes more time and will be completed further.The descriptions of modules' functionality may be changed due to code refactoring or changes in the future as well.
Most data structures and functions are not well documented as well in this pull request.