docs: pin remote readability
Co-authored-by: Jessica Schilling <jessica@protocol.ai>
Marcin Rataj committed
Dec 14, 2020 at 17:52 UTC
1cb90d710976cc7ae31e7e96b1757bd5bd30f3b5
1 file changed
+14
-14
core/commands/pin/remotepin.go
+14
-14
@@ -106,7 +106,7 @@ The above command will block until remote service returns 'pinned' status,
106
which may take time depending on the size and available providers of the pinned
107
data.
108
109
-If you prefer to not wait for pinning confirmation and return immediatelly
109
+If you prefer to not wait for pinning confirmation and return immediately
110
after remote service confirms 'queued' status, add the '--background' flag:
111
112
$ ipfs pin remote add --service=mysrv --name=mypin --background bafkqaaa
@@ -240,7 +240,7 @@ Returns a list of objects that are pinned to a remote pinning service.
240
LongDescription: `
241
Returns a list of objects that are pinned to a remote pinning service.
242
243
-NOTE: by default it will only show matching objects in 'pinned' state.
243
+NOTE: By default, it will only show matching objects in 'pinned' state.
244
Pass '--status=queued,pinning,pinned,failed' to list pins in all states.
245
`,
246
},
@@ -248,8 +248,8 @@ Pass '--status=queued,pinning,pinned,failed' to list pins in all states.
248
Arguments: []cmds.Argument{},
249
Options: []cmds.Option{
250
pinServiceNameOption,
251
- cmds.StringOption(pinNameOptionName, "Return pins with names that contain provided value (case-sensitive, exact match)."),
252
- cmds.DelimitedStringsOption(",", pinCIDsOptionName, "Return pins for the specified CIDs (comma separated)."),
251
+ cmds.StringOption(pinNameOptionName, "Return pins with names that contain the value provided (case-sensitive, exact match)."),
252
+ cmds.DelimitedStringsOption(",", pinCIDsOptionName, "Return pins for the specified CIDs (comma-separated)."),
253
cmds.DelimitedStringsOption(",", pinStatusOptionName, "Return pins with the specified statuses (queued,pinning,pinned,failed).").WithDefault([]string{"pinned"}),
254
},
255
Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
@@ -325,11 +325,11 @@ func lsRemote(ctx context.Context, req *cmds.Request, c *pinclient.Client) (chan
325
var rmRemotePinCmd = &cmds.Command{
326
Helptext: cmds.HelpText{
327
Tagline: "Remove pins from remote pinning service.",
328
- ShortDescription: "Removes the remote pin allowing it to be garbage collected if needed.",
328
+ ShortDescription: "Removes the remote pin, allowing it to be garbage-collected if needed.",
329
LongDescription: `
330
-Removes remote pins allowing them to be garbage collected if needed.
330
+Removes remote pins, allowing them to be garbage-collected if needed.
331
332
-This command accepts the same search query parameters as 'ls' and it is a good
332
+This command accepts the same search query parameters as 'ls', and it is good
333
practice to execute 'ls' before 'rm' to confirm the list of pins to be removed.
334
335
To remove a single pin for a specific CID:
@@ -337,14 +337,14 @@ To remove a single pin for a specific CID:
337
$ ipfs pin remote ls --service=mysrv --cid=bafkqaaa
338
$ ipfs pin remote rm --service=mysrv --cid=bafkqaaa
339
340
-When more than one pin is matching the query on the remote service an error is
341
-returned. To confirm removal of multiple pins pass '--force':
340
+When more than one pin matches the query on the remote service, an error is
341
+returned. To confirm the removal of multiple pins, pass '--force':
342
343
$ ipfs pin remote ls --service=mysrv --name=popular-name
344
$ ipfs pin remote rm --service=mysrv --name=popular-name --force
345
346
NOTE: When no '--status' is passed, implicit '--status=pinned' is used.
347
-To list and then remove all pending pin requests pass an explicit status list:
347
+To list and then remove all pending pin requests, pass an explicit status list:
348
349
$ ipfs pin remote ls --service=mysrv --status=queued,pinning,failed
350
$ ipfs pin remote rm --service=mysrv --status=queued,pinning,failed --force
@@ -403,9 +403,9 @@ To list and then remove all pending pin requests pass an explicit status list:
403
var addRemotePinServiceCmd = &cmds.Command{
404
Helptext: cmds.HelpText{
405
Tagline: "Add remote pinning service.",
406
- ShortDescription: "Add a credentials for access to a remote pinning service.",
406
+ ShortDescription: "Add credentials for access to a remote pinning service.",
407
LongDescription: `
408
-Add a credentials for access to a remote pinning service and store them in the
408
+Add credentials for access to a remote pinning service and store them in the
409
config under Pinning.RemoteServices map.
410
411
TIP:
@@ -517,8 +517,8 @@ var lsRemotePinServiceCmd = &cmds.Command{
517
LongDescription: `
518
List remote pinning services.
519
520
-By default only a name and an endpoint are listed, however one can pass '--stat'
521
-to test each endpoint by fetching pin counts for each state:
520
+By default, only a name and an endpoint are listed; however, one can pass
521
+'--stat' to test each endpoint by fetching pin counts for each state:
522
523
$ ipfs pin remote service ls --stat
524
goodsrv https://pin-api.example.com 0/0/0/0