docs: add and fix crate-level documentation for all CosmWasm crates #2510
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
chipshort
reviewed
Jun 26, 2025
| //! CosmWasm is a smart contract platform for the Cosmos ecosystem. | ||
| //! This binary provides a CLI tool for verifying CosmWasm smart contracts before uploading to a blockchain. | ||
| //! | ||
| //! For more information, see: <https://docs.cosmwasm.com> |
There was a problem hiding this comment.
The docs were recently moved to https://cosmwasm.cosmos.network, so I would link to that.
Comment on lines
+6
to
+9
| // The crypto crate is intended to be used in internal crates / utils. | ||
| // Please don't use any of these types directly, as | ||
| // they might change frequently, or be removed in the future. | ||
| // This crate does not adhere to semantic versioning. |
There was a problem hiding this comment.
Now this is not part of the crate docs anymore, but it really should be. Let's just keep this note part of the crate docs below the new explainer.
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.
Fix #2234
This commit adds or updates crate-level documentation comments (//! ...) for all main CosmWasm crates in the repository.