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

Make all Taglines use imperative mood #3041

Merged
merged 1 commit into from
Aug 16, 2016
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 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: "Interact with the bitswap agent.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure this is a useful change; bitswap isn't a command, it is a set of subcommands.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is fine, the previous tag wasnt imperative

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@whyrusleeping thinks it's fine. Works for me.

ShortDescription: ``,
},
Subcommands: map[string]*cmds.Command{
Expand Down
4 changes: 2 additions & 2 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: "Interact with raw IPFS blocks.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consistency -- using the same verb for all the toplevel commands that contain other subcommands.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@whyrusleeping thinks it's fine. Works for me.

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 Down Expand Up @@ -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: "Store input as an 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
4 changes: 2 additions & 2 deletions core/commands/bootstrap.go
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ in the bootstrap list).`,

var bootstrapRemoveCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Removes peers from the bootstrap list.",
Tagline: "Remove peers from the bootstrap list.",
ShortDescription: `Outputs the list of peers that were removed.
` + bootstrapSecurityWarning,
},
Expand Down Expand Up @@ -250,7 +250,7 @@ var bootstrapRemoveCmd = &cmds.Command{

var bootstrapRemoveAllCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Removes all peers from the bootstrap list.",
Tagline: "Remove all peers from the bootstrap list.",
ShortDescription: `Outputs the list of peers that were removed.`,
},

Expand Down
6 changes: 3 additions & 3 deletions core/commands/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Set the value of the 'datastore.path' key:

var configShowCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Outputs the content of the config file.",
Tagline: "Output config file contents.",
ShortDescription: `
WARNING: Your private key is stored in the config file, and it will be
included in the output of this command.
Expand Down Expand Up @@ -182,7 +182,7 @@ included in the output of this command.

var configEditCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Opens the config file for editing in $EDITOR.",
Tagline: "Open the config file for editing in $EDITOR.",
ShortDescription: `
To use 'ipfs config edit', you must have the $EDITOR environment
variable set to your preferred text editor.
Expand All @@ -205,7 +205,7 @@ variable set to your preferred text editor.

var configReplaceCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Replaces the config with <file>.",
Tagline: "Replace the config with <file>.",
ShortDescription: `
Make sure to back up the config file first if neccessary, as this operation
can't be undone.
Expand Down
4 changes: 2 additions & 2 deletions core/commands/diag.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var DefaultDiagnosticTimeout = time.Second * 20

var DiagCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Generates diagnostic reports.",
Tagline: "Generate diagnostic reports.",
},

Subcommands: map[string]*cmds.Command{
Expand All @@ -54,7 +54,7 @@ var DiagCmd = &cmds.Command{

var diagNetCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Generates a network diagnostics report.",
Tagline: "Generate a network diagnostics report.",
ShortDescription: `
Sends out a message to each node in the network recursively
requesting a listing of data about them including number of
Expand Down
2 changes: 1 addition & 1 deletion 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: "Resolve 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
2 changes: 1 addition & 1 deletion core/commands/files/files.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ var log = logging.Logger("cmds/files")

var FilesCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Manipulate unixfs files.",
Tagline: "Interact with unixfs files.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the change?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@whyrusleeping thinks it's fine. Works for me.

ShortDescription: `
Files is an API for manipulating IPFS objects as if they were a unix
filesystem.
Expand Down
2 changes: 1 addition & 1 deletion core/commands/ipns.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (

var IpnsCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Gets the value currently published at an IPNS name.",
Tagline: "Get the value currently published at an IPNS name.",
ShortDescription: `
IPNS is a PKI namespace, where names are the hashes of public keys, and
the private key enables publishing new (signed) values. In resolve, the
Expand Down
2 changes: 1 addition & 1 deletion core/commands/mount_nofuse.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (

var MountCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Mounts IPFS to the filesystem (disabled).",
Tagline: "Mount IPFS to the filesystem (disabled).",
ShortDescription: `
This version of ipfs is compiled without fuse support, which is required
for mounting. If you'd like to be able to mount, please use a version of
Expand Down
2 changes: 1 addition & 1 deletion core/commands/mount_unix.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (

var MountCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Mounts IPFS to the filesystem (read-only).",
Tagline: "Mount IPFS to the filesystem (read-only).",
ShortDescription: `
Mount ipfs at a read-only mountpoint on the OS (default: /ipfs and /ipns).
All ipfs objects will be accessible under that directory. Note that the
Expand Down
2 changes: 1 addition & 1 deletion core/commands/name.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ type IpnsEntry struct {

var NameCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "IPFS namespace (IPNS) tool.",
Tagline: "Interact with the IPFS namespace (IPNS).",
ShortDescription: `
IPNS is a PKI namespace, where names are the hashes of public keys, and
the private key enables publishing new (signed) values. In both publish
Expand Down
2 changes: 1 addition & 1 deletion core/commands/object/diff.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ type Changes struct {

var ObjectDiffCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Takes a diff of the two given objects.",
Tagline: "Display the diff between two ipfs objects.",
ShortDescription: `
'ipfs object diff' is a command used to show the differences between
two ipfs objects.`,
Expand Down
8 changes: 4 additions & 4 deletions core/commands/object/object.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ directly.`,

var ObjectDataCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Outputs the raw bytes in an IPFS object.",
Tagline: "Output the raw bytes of an IPFS object.",
ShortDescription: `
'ipfs object data' is a plumbing command for retrieving the raw bytes stored
in a DAG node. It outputs to stdout, and <key> is a base58 encoded multihash.
Expand Down Expand Up @@ -99,7 +99,7 @@ is the raw data of the object.

var ObjectLinksCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Outputs the links pointed to by the specified object.",
Tagline: "Output the links pointed to by the specified object.",
ShortDescription: `
'ipfs object links' is a plumbing command for retrieving the links from
a DAG node. It outputs to stdout, and <key> is a base58 encoded
Expand Down Expand Up @@ -293,7 +293,7 @@ var ObjectStatCmd = &cmds.Command{

var ObjectPutCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Stores input as a DAG object, outputs its key.",
Tagline: "Store input as a DAG object, print its key.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Print is a subset of output, I would think. Could probably stay with output.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree it's a subset, but it seemed like a useful distinction to make.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. Print feels like it should mean stderr, to me, but I think this is just stdout. @whyrusleeping?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think print is fine

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@whyrusleeping thinks it's fine. Works for me.

ShortDescription: `
'ipfs object put' is a plumbing command for storing DAG nodes.
It reads from stdin, and the output is a base58 encoded multihash.
Expand Down Expand Up @@ -384,7 +384,7 @@ And then run:

var ObjectNewCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Creates a new object from an ipfs template.",
Tagline: "Create a new object from an ipfs template.",
ShortDescription: `
'ipfs object new' is a plumbing command for creating new DAG nodes.
`,
Expand Down
4 changes: 2 additions & 2 deletions core/commands/pin.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ type PinOutput struct {

var addPinCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Pins objects to local storage.",
Tagline: "Pin objects to local storage.",
ShortDescription: "Stores an IPFS object(s) from a given path locally to disk.",
},

Expand Down Expand Up @@ -95,7 +95,7 @@ var addPinCmd = &cmds.Command{

var rmPinCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Removes the pinned object from local storage.",
Tagline: "Remove pinned objects from local storage.",
ShortDescription: `
Removes the pin from the given object allowing it to be garbage
collected if needed. (By default, recursively. Use -r=false for direct pins)
Expand Down
4 changes: 2 additions & 2 deletions core/commands/refs.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func KeyListTextMarshaler(res cmds.Response) (io.Reader, error) {

var RefsCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Lists links (references) from an object.",
Tagline: "List links (references) from an object.",
ShortDescription: `
Lists the hashes of all the links an IPFS or IPNS object(s) contains,
with the following format:
Expand Down Expand Up @@ -130,7 +130,7 @@ NOTE: List all references recursively by using the flag '-r'.

var RefsLocalCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Lists all local references.",
Tagline: "List all local references.",
ShortDescription: `
Displays the hashes of all local objects.
`,
Expand Down
4 changes: 2 additions & 2 deletions core/commands/repo.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type RepoVersion struct {

var RepoCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Manipulate the IPFS repo.",
Tagline: "Interact with the IPFS repo.",
ShortDescription: `
'ipfs repo' is a plumbing command used to manipulate the repo.
`,
Expand Down Expand Up @@ -172,7 +172,7 @@ Version string The repo version.

var RepoFsckCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Removes repo lockfiles.",
Tagline: "Remove repo lockfiles.",
ShortDescription: `
'ipfs repo fsck' is a plumbing command that will remove repo and level db
lockfiles, as well as the api file. This command can only run when no ipfs
Expand Down
2 changes: 1 addition & 1 deletion core/commands/swarm.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ type addrMap struct {

var SwarmCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Swarm inspection tool.",
Tagline: "Interact with the swarm.",
ShortDescription: `
'ipfs swarm' is a tool to manipulate the network swarm. The swarm is the
component that opens, listens for, and maintains connections to other
Expand Down
2 changes: 1 addition & 1 deletion core/commands/sysdiag.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (

var sysDiagCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Prints out system diagnostic information.",
Tagline: "Print system diagnostic information.",
ShortDescription: `
Prints out information about your computer to aid in easier debugging.
`,
Expand Down
2 changes: 1 addition & 1 deletion core/commands/tar.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (

var TarCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Utility functions for tar files in IPFS.",
Tagline: "Interact with tar files in IPFS.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here: ipfs tar is a set of functions, and can't manipulate. Declarative syntax is fine.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@whyrusleeping thinks it's fine. Works for me.

},

Subcommands: map[string]*cmds.Command{
Expand Down
2 changes: 1 addition & 1 deletion core/commands/tour.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (

var tourCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "An introduction to IPFS.",
Tagline: "Provide an introduction to IPFS.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not necessary. "Introduce IPFS" might be better.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix this and we're good to merge?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, this is more accurate than my suggestion. Works for me.

ShortDescription: `
This is a tour that takes you through various IPFS concepts,
features, and tools to make sure you get up to speed with
Expand Down
2 changes: 1 addition & 1 deletion core/commands/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type VersionOutput struct {

var VersionCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Shows ipfs version information.",
Tagline: "Show ipfs version information.",
ShortDescription: "Returns the current version of ipfs and exits.",
},

Expand Down