Skip to content
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

Put all Taglines & most Option descriptions in active, present tense #3018

Closed
wants to merge 1 commit into from
Closed
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
8 changes: 4 additions & 4 deletions core/commands/active.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (

var ActiveReqsCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "List commands run on this ipfs node.",
Tagline: "Lists commands run on this ipfs node.",
ShortDescription: `
Lists running and recently run commands.
`,
Expand All @@ -22,7 +22,7 @@ Lists running and recently run commands.
res.SetOutput(req.InvocContext().ReqLog.Report())
},
Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Print extra information.").Default(false),
cmds.BoolOption("verbose", "v", "Prints extra information.").Default(false),
},
Subcommands: map[string]*cmds.Command{
"clear": clearInactiveCmd,
Expand Down Expand Up @@ -87,7 +87,7 @@ Lists running and recently run commands.

var clearInactiveCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Clear inactive requests from the log.",
Tagline: "Clears inactive requests from the log.",
},
Run: func(req cmds.Request, res cmds.Response) {
req.InvocContext().ReqLog.ClearInactive()
Expand All @@ -96,7 +96,7 @@ var clearInactiveCmd = &cmds.Command{

var setRequestClearCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Set how long to keep inactive requests in the log.",
Tagline: "Sets how long to keep inactive requests in the log.",
},
Arguments: []cmds.Argument{
cmds.StringArg("time", true, false, "Time to keep inactive requests in log."),
Expand Down
18 changes: 9 additions & 9 deletions core/commands/add.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const (

var AddCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Add a file to ipfs.",
Tagline: "Adds a file to ipfs.",
ShortDescription: `
Adds contents of <path> to ipfs. Use -r to add directories.
Note that directories are added recursively, to form the ipfs
Expand Down Expand Up @@ -66,15 +66,15 @@ You can now refer to the added file in a gateway, like so:
},
Options: []cmds.Option{
cmds.OptionRecursivePath, // a builtin option that allows recursive paths (-r, --recursive)
cmds.BoolOption(quietOptionName, "q", "Write minimal output.").Default(false),
cmds.BoolOption(silentOptionName, "Write no output.").Default(false),
cmds.BoolOption(progressOptionName, "p", "Stream progress data.").Default(true),
cmds.BoolOption(trickleOptionName, "t", "Use trickle-dag format for dag generation.").Default(false),
cmds.BoolOption(onlyHashOptionName, "n", "Only chunk and hash - do not write to disk.").Default(false),
cmds.BoolOption(wrapOptionName, "w", "Wrap files with a directory object.").Default(false),
cmds.BoolOption(hiddenOptionName, "H", "Include files that are hidden. Only takes effect on recursive add.").Default(false),
cmds.BoolOption(quietOptionName, "q", "Writes minimal output.").Default(false),
cmds.BoolOption(silentOptionName, "Writes no output.").Default(false),
cmds.BoolOption(progressOptionName, "p", "Streams progress data.").Default(true),
cmds.BoolOption(trickleOptionName, "t", "Uses trickle-dag format for dag generation.").Default(false),
cmds.BoolOption(onlyHashOptionName, "n", "Only chunk and hash - does not write to disk.").Default(false),
cmds.BoolOption(wrapOptionName, "w", "Wraps files with a directory object.").Default(false),
cmds.BoolOption(hiddenOptionName, "H", "Includes files that are hidden. Only takes effect on recursive add.").Default(false),
cmds.StringOption(chunkerOptionName, "s", "Chunking algorithm to use."),
cmds.BoolOption(pinOptionName, "Pin this object when adding.").Default(true),
cmds.BoolOption(pinOptionName, "Pins the added object(s).").Default(true),
},
PreRun: func(req cmds.Request) error {
if quiet, _, _ := req.Option(quietOptionName).Bool(); quiet {
Expand Down
12 changes: 6 additions & 6 deletions core/commands/bitswap.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (

var BitswapCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "A set of commands to manipulate the bitswap agent.",
Tagline: "Interacts with the bitswap agent.",
ShortDescription: ``,
},
Subcommands: map[string]*cmds.Command{
Expand All @@ -28,7 +28,7 @@ var BitswapCmd = &cmds.Command{

var unwantCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Remove a given block from your wantlist.",
Tagline: "Removes a given block from your wantlist.",
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, true, "Key(s) to remove from your wantlist.").EnableStdin(),
Expand Down Expand Up @@ -68,12 +68,12 @@ var unwantCmd = &cmds.Command{

var showWantlistCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Show blocks currently on the wantlist.",
Tagline: "Shows the blocks currently on your wantlist.",
ShortDescription: `
Print out all blocks currently on the bitswap wantlist for the local peer.`,
Prints out all blocks currently on the bitswap wantlist for the local peer.`,
},
Options: []cmds.Option{
cmds.StringOption("peer", "p", "Specify which peer to show wantlist for. Default: self."),
cmds.StringOption("peer", "p", "Peer to show wantlist for. Default: self."),
},
Type: KeyList{},
Run: func(req cmds.Request, res cmds.Response) {
Expand Down Expand Up @@ -117,7 +117,7 @@ Print out all blocks currently on the bitswap wantlist for the local peer.`,

var bitswapStatCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Show some diagnostic information on the bitswap agent.",
Tagline: "Shows some diagnostic information on the bitswap agent.",
ShortDescription: ``,
},
Type: bitswap.Stat{},
Expand Down
8 changes: 4 additions & 4 deletions core/commands/block.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ func (bs BlockStat) String() string {

var BlockCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Manipulate raw IPFS blocks.",
Tagline: "Manipulates raw IPFS blocks.",
ShortDescription: `
'ipfs block' is a plumbing command used to manipulate raw ipfs blocks.
Reads from stdin or writes to stdout, and <key> is a base58 encoded
Expand All @@ -43,7 +43,7 @@ multihash.

var blockStatCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Print information of a raw IPFS block.",
Tagline: "Prints information about a raw IPFS block.",
ShortDescription: `
'ipfs block stat' is a plumbing command for retrieving information
on raw ipfs blocks. It outputs the following to stdout:
Expand Down Expand Up @@ -80,7 +80,7 @@ on raw ipfs blocks. It outputs the following to stdout:

var blockGetCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Get a raw IPFS block.",
Tagline: "Gets a raw IPFS block.",
ShortDescription: `
'ipfs block get' is a plumbing command for retrieving raw ipfs blocks.
It outputs to stdout, and <key> is a base58 encoded multihash.
Expand All @@ -103,7 +103,7 @@ It outputs to stdout, and <key> is a base58 encoded multihash.

var blockPutCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Stores input as an IPFS block.",
Tagline: "Stores input as a raw IPFS block.",
ShortDescription: `
'ipfs block put' is a plumbing command for storing raw ipfs blocks.
It reads from stdin, and <key> is a base58 encoded multihash.
Expand Down
12 changes: 6 additions & 6 deletions core/commands/bootstrap.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ var peerOptionDesc = "A peer to add to the bootstrap list (in the format '<multi

var BootstrapCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Show or edit the list of bootstrap peers.",
Tagline: "Interacts with the list of bootstrap peers.",
ShortDescription: `
Running 'ipfs bootstrap' with no arguments will run 'ipfs bootstrap list'.
` + bootstrapSecurityWarning,
Expand All @@ -40,7 +40,7 @@ Running 'ipfs bootstrap' with no arguments will run 'ipfs bootstrap list'.

var bootstrapAddCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Add peers to the bootstrap list.",
Tagline: "Adds peers to the bootstrap list.",
ShortDescription: `Outputs a list of peers that were added (that weren't already
in the bootstrap list).
` + bootstrapSecurityWarning,
Expand All @@ -51,7 +51,7 @@ in the bootstrap list).
},

Options: []cmds.Option{
cmds.BoolOption("default", "Add default bootstrap nodes. (Deprecated, use 'default' subcommand instead)"),
cmds.BoolOption("default", "Adds default bootstrap nodes. (Deprecated, use 'default' subcommand instead)"),
},
Subcommands: map[string]*cmds.Command{
"default": bootstrapAddDefaultCmd,
Expand Down Expand Up @@ -129,7 +129,7 @@ in the bootstrap list).

var bootstrapAddDefaultCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Add default peers to the bootstrap list.",
Tagline: "Adds default peers to the bootstrap list.",
ShortDescription: `Outputs a list of peers that were added (that weren't already
in the bootstrap list).`,
},
Expand Down Expand Up @@ -190,7 +190,7 @@ var bootstrapRemoveCmd = &cmds.Command{
cmds.StringArg("peer", false, true, peerOptionDesc).EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("all", "Remove all bootstrap peers. (Deprecated, use 'all' subcommand)"),
cmds.BoolOption("all", "Removes all bootstrap peers. (Deprecated, use 'all' subcommand)"),
},
Subcommands: map[string]*cmds.Command{
"all": bootstrapRemoveAllCmd,
Expand Down Expand Up @@ -292,7 +292,7 @@ var bootstrapRemoveAllCmd = &cmds.Command{

var bootstrapListCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Show peers in the bootstrap list.",
Tagline: "Prints the peers in the bootstrap list.",
ShortDescription: "Peers are output in the format '<multiaddr>/<peerID>'.",
},

Expand Down
2 changes: 1 addition & 1 deletion core/commands/cat.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const progressBarMinSize = 1024 * 1024 * 8 // show progress bar for outputs > 8M

var CatCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Show IPFS object data.",
Tagline: "Shows IPFS object data.",
ShortDescription: "Displays the data contained by an IPFS or IPNS object(s) at the given path.",
},

Expand Down
4 changes: 2 additions & 2 deletions core/commands/commands.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ const (
func CommandsCmd(root *cmds.Command) *cmds.Command {
return &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "List all available commands.",
Tagline: "Lists all available commands.",
ShortDescription: `Lists all available commands (and subcommands) and exits.`,
},
Options: []cmds.Option{
cmds.BoolOption(flagsOptionName, "f", "Show command flags").Default(false),
cmds.BoolOption(flagsOptionName, "f", "Shows command flags").Default(false),
},
Run: func(req cmds.Request, res cmds.Response) {
rootCmd := cmd2outputCmd("ipfs", root)
Expand Down
6 changes: 3 additions & 3 deletions core/commands/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ type ConfigField struct {

var ConfigCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Get and set IPFS config values.",
Tagline: "Gets and sets IPFS config values.",
ShortDescription: `
'ipfs config' controls configuration variables. It works like 'git config'.
The configuration values are stored in a config file inside your IPFS
Expand All @@ -52,8 +52,8 @@ Set the value of the 'datastore.path' key:
cmds.StringArg("value", false, false, "The value to set the config entry to."),
},
Options: []cmds.Option{
cmds.BoolOption("bool", "Set a boolean value.").Default(false),
cmds.BoolOption("json", "Parse stringified JSON.").Default(false),
cmds.BoolOption("bool", "Sets a boolean value.").Default(false),
cmds.BoolOption("json", "Parses stringified JSON.").Default(false),
},
Run: func(req cmds.Request, res cmds.Response) {
args := req.Arguments()
Expand Down
22 changes: 11 additions & 11 deletions core/commands/dht.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ var ErrNotDHT = errors.New("routing service is not a DHT")

var DhtCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Issue commands directly through the DHT.",
Tagline: "Issues commands directly through the DHT.",
ShortDescription: ``,
},

Expand All @@ -36,15 +36,15 @@ var DhtCmd = &cmds.Command{

var queryDhtCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Find the closest Peer IDs to a given Peer ID by querying the DHT.",
Tagline: "Finds the closest Peer IDs to a given Peer ID by querying the DHT.",
ShortDescription: "Outputs a list of newline-delimited Peer IDs.",
},

Arguments: []cmds.Argument{
cmds.StringArg("peerID", true, true, "The peerID to run the query against."),
},
Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Print extra information.").Default(false),
cmds.BoolOption("verbose", "v", "Prints extra information.").Default(false),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
Expand Down Expand Up @@ -128,15 +128,15 @@ var queryDhtCmd = &cmds.Command{

var findProvidersDhtCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Find peers in the DHT that can provide a specific value, given a key.",
Tagline: "Finds peers in the DHT that can provide a specific value, given a key.",
ShortDescription: "Outputs a list of newline-delimited provider Peer IDs.",
},

Arguments: []cmds.Argument{
cmds.StringArg("key", true, true, "The key to find providers for."),
},
Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Print extra information.").Default(false),
cmds.BoolOption("verbose", "v", "Prints extra information.").Default(false),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
Expand Down Expand Up @@ -229,15 +229,15 @@ var findProvidersDhtCmd = &cmds.Command{

var findPeerDhtCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Query the DHT for all of the multiaddresses associated with a Peer ID.",
Tagline: "Queries the DHT for all of the multiaddresses associated with a Peer ID.",
ShortDescription: "Outputs a list of newline-delimited multiaddresses.",
},

Arguments: []cmds.Argument{
cmds.StringArg("peerID", true, true, "The ID of the peer to search for."),
},
Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Print extra information.").Default(false),
cmds.BoolOption("verbose", "v", "Prints extra information.").Default(false),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
Expand Down Expand Up @@ -328,7 +328,7 @@ var findPeerDhtCmd = &cmds.Command{

var getValueDhtCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Given a key, query the DHT for its best value.",
Tagline: "Given a key, queries the DHT for its best value.",
ShortDescription: `
Outputs the best value for the given key.

Expand All @@ -344,7 +344,7 @@ Different key types can specify other 'best' rules.
cmds.StringArg("key", true, true, "The key to find a value for."),
},
Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Print extra information.").Default(false),
cmds.BoolOption("verbose", "v", "Prints extra information.").Default(false),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
Expand Down Expand Up @@ -437,7 +437,7 @@ Different key types can specify other 'best' rules.

var putValueDhtCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Write a key/value pair to the DHT.",
Tagline: "Writes a key/value pair to the DHT.",
ShortDescription: `
Given a key of the form /foo/bar and a value of any form, this will write that
value to the DHT with that key.
Expand All @@ -462,7 +462,7 @@ NOTE: A value may not exceed 2048 bytes.
cmds.StringArg("value", true, false, "The value to store.").EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Print extra information.").Default(false),
cmds.BoolOption("verbose", "v", "Prints extra information.").Default(false),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
Expand Down
4 changes: 2 additions & 2 deletions core/commands/dns.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (

var DNSCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "DNS link resolver.",
Tagline: "Resolves DNS links.",
ShortDescription: `
Multihashes are hard to remember, but domain names are usually easy to
remember. To create memorable aliases for multihashes, DNS TXT
Expand Down Expand Up @@ -47,7 +47,7 @@ The resolver can recursively resolve:
cmds.StringArg("domain-name", true, false, "The domain-name name to resolve.").EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("recursive", "r", "Resolve until the result is not a DNS link.").Default(false),
cmds.BoolOption("recursive", "r", "Resolves until the result is not a DNS link.").Default(false),
},
Run: func(req cmds.Request, res cmds.Response) {

Expand Down
Loading