asset: Add extrinsic documentation #498
Merged
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 documentation provides a comprehensive overview of the 'create' function, describing its purpose, parameters, return values, potential errors, and the event it emits upon successful execution.
…nsic-documentation-#443
added documentation for issue function
Added documentation for status_change function.
Added documentation for vc_create function.
vatsa287
reviewed
Aug 3, 2024
pallets/asset/src/lib.rs
Outdated
| @@ -300,6 +300,34 @@ pub mod pallet { | |||
|
|
|||
| Ok(()) | |||
| } | |||
| /// Creates a new asset entry within a specified space. | |||
There was a problem hiding this comment.
Please move the method documentation to top of the actual method which the doc is targeted for & match its indentation.
There was a problem hiding this comment.
Please review it again, as I have updated the documentation accordingly.
9 tasks
|
@vidyaa01 Run the cargo format for the ci test to pass. Add the changes again, amend the commit and push the changes. |
Added documentation above the method and corrected the indentation accordingly.
vidyaa01
force-pushed
the
pallets/asset/src/lib.rs-Add-extrinsic-documentation-#443
branch
from
a096b8c
to
17852ef
Compare
|
Hey @vatsa287 , I have made the changes you requested and pushed the changes to the PR. It shows me dismissed stale review which wasn't my intention, can you guide me on further steps? |
vatsa287
changed the title
|
@amarts PTAL |
amarts
approved these changes
Sep 4, 2024
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.
Comprehensive Documentation Update
This PR introduces comprehensive documentation for the following extrinsic functions in our pallet:
Each function now includes detailed Rustdoc comments covering:
Fixes: #443