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

Fixed up docs for bitswap #2228

Merged
merged 1 commit into from
Jan 23, 2016
Merged

Fixed up docs for bitswap #2228

merged 1 commit into from
Jan 23, 2016

Conversation

RichardLitt
Copy link
Member

License: MIT
Signed-off-by: Richard Littauer [email protected]

License: MIT
Signed-off-by: Richard Littauer <[email protected]>
@RichardLitt RichardLitt added topic/docs-ipfs Topic docs-ipfs need/review Needs a review labels Jan 21, 2016
@@ -16,7 +16,7 @@ import (

var BitswapCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "A set of commands to manipulate the bitswap agent",
Tagline: "A set of commands to manipulate the bitswap agent.",
Copy link
Contributor

Choose a reason for hiding this comment

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

@RichardLitt if you grep for the entire Tagline:, most of the strings don't have the punctuation.

Copy link
Contributor

Choose a reason for hiding this comment

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

nvm, I raised the issue, so here it is #2231

Copy link
Contributor

Choose a reason for hiding this comment

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

There are significantly more tagline without '.', but however, cat does have it

Usage: cat [OPTION]... [FILE]...
Concatenate FILE(s) to standard output.

With no FILE, or when FILE is -, read standard input.

  -A, --show-all           equivalent to -vET
  -b, --number-nonblank    number nonempty output lines, overrides -n
  -e                       equivalent to -vE
  -E, --show-ends          display $ at end of each line
  -n, --number             number all output lines
  -s, --squeeze-blank      suppress repeated empty output lines
  -t                       equivalent to -vT
  -T, --show-tabs          display TAB characters as ^I
  -u                       (ignored)
  -v, --show-nonprinting   use ^ and M- notation, except for LFD and TAB
      --help     display this help and exit
      --version  output version information and exit

Examples:
  cat f - g  Output f's contents, then standard input, then g's contents.
  cat        Copy standard input to standard output.

GNU coreutils online help: <http://www.gnu.org/software/coreutils/>
Full documentation at: <http://www.gnu.org/software/coreutils/cat>
or available locally via: info '(coreutils) cat invocation'

Copy link
Member Author

Choose a reason for hiding this comment

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

Cool. I say we go for it, because we haven't largely out of laziness. #2231 looks good.

@rht
Copy link
Contributor

rht commented Jan 23, 2016

The scope of this PR is specific to bitswap, therefore LGTM.

@rht
Copy link
Contributor

rht commented Jan 23, 2016

(stop @rht soon)

rht pushed a commit that referenced this pull request Jan 23, 2016
Fixed up docs for bitswap
@rht rht merged commit fce3840 into master Jan 23, 2016
@rht rht deleted the docs/bitswap branch January 23, 2016 05:24
@jbenet
Copy link
Member

jbenet commented Jan 23, 2016

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/review Needs a review topic/docs-ipfs Topic docs-ipfs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants