8000 docs(cmd): improve command descriptions by soniasingla · Pull Request #1354 · ignite/cli · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs(cmd): improve command descriptions #1354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion starport/cmd/chain.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import "github.com/spf13/cobra"
func NewChain() *cobra.Command {
c := &cobra.Command{
Use: "chain [command]",
Short: "Build, initialize, and start a blockchain",
Short: "Build, initialize, and start a blockchain in development",
Aliases: []string{"c"},
Args: cobra.ExactArgs(1),
}
Expand Down
4 changes: 2 additions & 2 deletions starport/cmd/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import "github.com/spf13/cobra"
func NewGenerate() *cobra.Command {
c := &cobra.Command{
Use: "generate [command]",
Short: "Generate commands produce source code that is required for your project to compile",
Long: `Generate commands produce source code that is required for your project to compile.
Short: "Generate clients, API docs from source code",
Long: `Generate clients, API docs from source code.

Such as compiling protocol buffer files into Go or implement particular functionality, for example, generating an OpenAPI spec.

Expand Down
2 changes: 1 addition & 1 deletion starport/cmd/network.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ const (
func NewNetwork() *cobra.Command {
c := &cobra.Command{
Use: "network",
Short: "Launch a blockchain network in a decentralized way",
Short: "Launch a blockchain network in production",
Args: cobra.ExactArgs(1),
}

Expand Down
2 changes: 1 addition & 1 deletion starport/cmd/scaffold.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const (
func NewScaffold() *cobra.Command {
c := &cobra.Command{
Use: "scaffold [command]",
Short: "Scaffold a new blockchain or scaffold components inside an existing one",
Short: "Scaffold a new blockchain, module, message, query, and more",
Aliases: []string{"s"},
Args: cobra.ExactArgs(1),
}
Expand Down
2 changes: 1 addition & 1 deletion starport/cmd/scaffold_chain.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const (
func NewScaffoldChain() *cobra.Command {
c := &cobra.Command{
Use: "chain [github.com/org/repo]",
Short: "Scaffold a new blockchain",
Short: "Fully-featured Cosmos SDK blockchain",
Long: "Scaffold a new Cosmos SDK blockchain with a default directory structure",
Args: cobra.ExactArgs(1),
RunE: scaffoldChainHandler,
Expand Down
2 changes: 1 addition & 1 deletion starport/cmd/scaffold_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
func NewScaffoldList() *cobra.Command {
c := &cobra.Command{
Use: "list NAME [field]...",
Short: "Scaffold a list",
Short: "CRUD for data stored as an array",
Args: cobra.MinimumNArgs(1),
RunE: scaffoldListHandler,
}
Expand Down
2 changes: 1 addition & 1 deletion starport/cmd/scaffold_map.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
func NewScaffoldMap() *cobra.Command {
c := &cobra.Command{
Use: "map NAME [field]...",
Short: "Scaffold a map",
Short: "CRUD for data stored as key-value pairs",
Args: cobra.MinimumNArgs(1),
RunE: scaffoldMapHandler,
}
Expand Down
2 changes: 1 addition & 1 deletion starport/cmd/scaffold_message.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (
func NewScaffoldMessage() *cobra.Command {
c := &cobra.Command{
Use: "message [name] [field1] [field2] ...",
Short: "Scaffold a Cosmos SDK message",
Short: "Message to perform state transition on the blockchain",
Args: cobra.MinimumNArgs(1),
RunE: messageHandler,
}
Expand Down
2 changes: 1 addition & 1 deletion starport/cmd/scaffold_package.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const (
func NewScaffoldPacket() *cobra.Command {
c := &cobra.Command{
Use: "packet [packetName] [field1] [field2] ... --module [moduleName]",
Short: "Scaffold an IBC packet",
Short: "Message for sending an IBC packet",
Long: "Scaffold an IBC packet in a specific IBC-enabled Cosmos SDK module",
Args: cobra.MinimumNArgs(1),
RunE: createPacketHandler,
Expand Down
2 changes: 1 addition & 1 deletion starport/cmd/scaffold_query.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const (
func NewScaffoldQuery() *cobra.Command {
c := &cobra.Command{
Use: "query [name] [request_field1] [request_field2] ...",
Short: "Scaffold a Cosmos SDK query",
Short: "Query to get data from the blockchain",
Args: cobra.MinimumNArgs(1),
RunE: queryHandler,
}
Expand Down
2 changes: 1 addition & 1 deletion starport/cmd/scaffold_single.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
func NewScaffoldSingle() *cobra.Command {
c := &cobra.Command{
Use: "single NAME [field]...",
Short: "Scaffold a singleton",
Short: "CRUD for data stored in a single location",
Args: cobra.MinimumNArgs(1),
RunE: scaffoldSingleHandler,
}
Expand Down
2 changes: 1 addition & 1 deletion starport/cmd/scaffold_vue.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const flagPath = "path"
func NewScaffoldVue() *cobra.Command {
c := &cobra.Command{
Use: "vue",
Short: "Scaffold a Vue.JS app for a chain",
Short: "Vue 3 web app template",
Args: cobra.NoArgs,
RunE: scaffoldVueHandler,
}
Expand Down
0