add docs for cli commands #811
Draft
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
|
Still needs some more work.. |
LGLO
reviewed
May 22, 2025
LGLO
reviewed
May 22, 2025
LGLO
reviewed
May 22, 2025
| ``` | ||
|
|
||
| ##### upsert-d-parameter | ||
| Upsert D-parameter |
There was a problem hiding this comment.
I'm not sure if it isn't enough to enumerate governance related smart contracts without additional documentation here. IMO these comments don't add value.
There was a problem hiding this comment.
100% right and agreed. That's the very reason why the PR is still in DRAFT. Whenever the documentation only repeats the name of the command that really doesn't help a lot
I started off with copying what the user is provided in the --help which as you can see in most cases really isn't a lot
Co-authored-by: Lech Głowiak <[email protected]>
Co-authored-by: Lech Głowiak <[email protected]>
| --genesis-utxo <GENESIS_UTXO> | ||
| ``` | ||
| ###### update | ||
| Updates a key-value pair in the Governed Map. If the key is missing it won't be inserted. |
There was a problem hiding this comment.
There is also
/// If provided, update will fail unless the current value matches the one on the ledger.
current_value: Option<ByteString>,
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.
Description
Adds documentation of all pc cli commands
Checklist
changelog.mdfor affected crate