docs: cosmetic fixes of help text #8010
Conversation
Unfortunately, API docs are genereted from go-ipfs sources via https://github.com/ipfs/http-api-docs so it all gets lost when API docs for new version are re-generated. This re-applies manual fixes from: https://docs.ipfs.io/reference/http/api/ so the next time http-api-docs are re-generated, those changes stay.
This is a cosmetic change to 'ipfs --help' that reorders operations to prioritize 'dag' and 'files' over legacy 'object'. Context: #7936
| init Initialize local IPFS configuration | ||
| add <path> Add a file to IPFS | ||
| cat <ref> Show IPFS object data | ||
| get <ref> Download IPFS objects |
There was a problem hiding this comment.
I feel like we should add, that the file/object isn't only fetched to the local node, but also stored in the current working directory in a new folder which is named after the CID.
There was a problem hiding this comment.
Mind opening a separate PR with your suggestions?
I'd like to keep this one scoped to known fixes and avoid bikeshed :)
|
|
||
| ADVANCED COMMANDS | ||
| daemon Start a long-running daemon process | ||
| mount Mount an ipfs read-only mount point | ||
| mount Mount an IPFS read-only mount point |
There was a problem hiding this comment.
I mean, yeah we only support read-only mount points... but I don't think this command is in general limited to this. Also, the sentence is a bit confusing... what is an "IPFS read-only mount point" exactly?
| block Interact with raw blocks in the datastore | ||
| object Interact with raw dag nodes | ||
| files Interact with objects as if they were a unix filesystem | ||
|
|
||
| ADVANCED COMMANDS | ||
| daemon Start a long-running daemon process |
There was a problem hiding this comment.
"Start IPFS as a daemon (process)"
How long doesn't matter for this command to work
| @@ -30,8 +30,8 @@ const ( | |||
|
|
|||
| var VersionCmd = &cmds.Command{ | |||
| Helptext: cmds.HelpText{ | |||
| Tagline: "Show ipfs version information.", | |||
| ShortDescription: "Returns the current version of ipfs and exits.", | |||
| Tagline: "Show IPFS version information.", | |||
There was a problem hiding this comment.
Show or Shows? We need to decide in this and many other cases which we prefer:
- (It) Shows IPFS version information.
or
- Show IPFS version information.
|
Applied some suggestions from review but limited scope to uncontroversial changes. |
People fixed a bunch of style issues in https://docs.ipfs.io/reference/http/api/
Unfortunately, those API docs are generated from go-ipfs sources via https://github.com/ipfs/http-api-docs tool, so it all gets lost when API docs for new version are re-generated.
This PR:
Re-applies manual fixes from https://docs.ipfs.io/reference/http/api/ to
--helptext in go-ipfs.This way the next time http-api-docs are re-generated, those changes stay.
Updates and reorders operations on
ipfs --helpto prioritize 'dag' and 'files' over legacy 'object'Context: Deprecate Object API #7936
Clarifies that
ipfs objectonly works withdag-pb(multiformats/table.csv#L42) – closes Document that the ipfs object command only works with DagPB nodes #7396cc @aschmahmann – potential candidate for inclusion in 0.8.1
cc @johnnymatthews for general awareness