Fixed up docs for bitswap
License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
Jan 21, 2016 at 17:53 UTC
a998dbf285af3034c0da8f5bccbd9af896fcfc30
1 file changed
+8
-8
core/commands/bitswap.go
+8
-8
@@ -16,7 +16,7 @@ import (
16
17
var BitswapCmd = &cmds.Command{
18
Helptext: cmds.HelpText{
19
- Tagline: "A set of commands to manipulate the bitswap agent",
19
+ Tagline: "A set of commands to manipulate the bitswap agent.",
20
ShortDescription: ``,
21
},
22
Subcommands: map[string]*cmds.Command{
@@ -28,10 +28,10 @@ var BitswapCmd = &cmds.Command{
28
29
var unwantCmd = &cmds.Command{
30
Helptext: cmds.HelpText{
31
- Tagline: "Remove a given block from your wantlist",
31
+ Tagline: "Remove a given block from your wantlist.",
32
},
33
Arguments: []cmds.Argument{
34
- cmds.StringArg("key", true, true, "key to remove from your wantlist").EnableStdin(),
34
+ cmds.StringArg("key", true, true, "Key to remove from your wantlist.").EnableStdin(),
35
},
36
Run: func(req cmds.Request, res cmds.Response) {
37
nd, err := req.InvocContext().GetNode()
@@ -55,7 +55,7 @@ var unwantCmd = &cmds.Command{
55
for _, arg := range req.Arguments() {
56
dec := key.B58KeyDecode(arg)
57
if dec == "" {
58
- res.SetError(fmt.Errorf("incorrectly formatted key: %s", arg), cmds.ErrNormal)
58
+ res.SetError(fmt.Errorf("Incorrectly formatted key: %s", arg), cmds.ErrNormal)
59
return
60
}
61
@@ -68,12 +68,12 @@ var unwantCmd = &cmds.Command{
68
69
var showWantlistCmd = &cmds.Command{
70
Helptext: cmds.HelpText{
71
- Tagline: "Show blocks currently on the wantlist",
71
+ Tagline: "Show blocks currently on the wantlist.",
72
ShortDescription: `
73
-Print out all blocks currently on the bitswap wantlist for the local peer`,
73
+Print out all blocks currently on the bitswap wantlist for the local peer.`,
74
},
75
Options: []cmds.Option{
76
- cmds.StringOption("peer", "p", "specify which peer to show wantlist for (default self)"),
76
+ cmds.StringOption("peer", "p", "Specify which peer to show wantlist for. Default: self."),
77
},
78
Type: KeyList{},
79
Run: func(req cmds.Request, res cmds.Response) {
@@ -117,7 +117,7 @@ Print out all blocks currently on the bitswap wantlist for the local peer`,
117
118
var bitswapStatCmd = &cmds.Command{
119
Helptext: cmds.HelpText{
120
- Tagline: "show some diagnostic information on the bitswap agent",
120
+ Tagline: "Show some diagnostic information on the bitswap agent.",
121
ShortDescription: ``,
122
},
123
Type: bitswap.Stat{},