style(golang): Align CLI command fields with upstream recommendations #8678
Conversation
There was a problem hiding this comment.
This file is copied directly from the upstream genaccounts.go. Would you please also make a PR against that file so that your changes benefit the Cosmos as a whole?
There was a problem hiding this comment.
This is a copy of another upstream file, testnet.go.
| func NewCmdSubmitCoreEvalProposal() *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "swingset-core-eval [[permit.json] [code.js]]...", | ||
| Use: "swingset-core-eval <permit.json code.js>...", |
There was a problem hiding this comment.
I'm not sure of the correct placement of angle brackets to indicate that these are pairs of filenames. Your rendition seems okay, but I wish there was something even clearer.
| Use: "deliver [json string]", | ||
| Short: "deliver inbound messages", | ||
| Args: cobra.ExactArgs(1), | ||
| Use: "deliver {<messages JSON> | @- | @<file path>}", |
There was a problem hiding this comment.
I don't know what a "messages JSON" is, as opposed to just a "JSON". Explain what @- does in the long description. Each command needs to either be self-contained or have an explicit reference to conventions that can be found somewhere else.
cf. https://pkg.go.dev/github.com/spf13/cobra#Command and https://github.com/spf13/cobra/blob/v1.8.0/site/content/user_guide.md#example Only optional arguments should be wrapped in square brackets, alternatives should be wrapped in curly braces, and `Long` strings should generally start similar to `Use`.
gibson042
force-pushed
the
gibson-2023-12-golang-cli-commands
branch
from
f7b96ae to
0887645
Compare
style(golang): Align CLI command fields with upstream recommendations
Description
cf. https://pkg.go.dev/github.com/spf13/cobra#Command and https://github.com/spf13/cobra/blob/v1.8.0/site/content/user_guide.md#example
Only optional arguments should be wrapped in square brackets, alternatives should be wrapped in curly braces, and
Longstrings should generally start similar toUse.Security Considerations
n/a
Scaling Considerations
n/a
Documentation Considerations
This improves self-documentation of CLI commands, reducing the need for external digging.
Testing Considerations
n/a
Upgrade Considerations
Deprecation of
agd testnet --vmay result in some noise, but no change in actual behavior.