-
-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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.", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why the change? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
@@ -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. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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.", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why the change? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
@@ -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 | ||
|
@@ -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.", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe 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? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i think print is fine There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
@@ -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. | ||
`, | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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.", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe 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{ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,7 +14,7 @@ import ( | |
|
||
var tourCmd = &cmds.Command{ | ||
Helptext: cmds.HelpText{ | ||
Tagline: "An introduction to IPFS.", | ||
Tagline: "Provide an introduction to IPFS.", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not necessary. "Introduce IPFS" might be better. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix this and we're good to merge? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.