-
-
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
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
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.
One nit but otherwise LGTM.
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.
Some language stuff. Not absolutely sure the rest is okay, I'm a bit too tired to do a full review right now.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
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.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Start IPFS as a daemon (process)"
How long doesn't matter for this command to work
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.
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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.
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
--help
text in go-ipfs.This way the next time http-api-docs are re-generated, those changes stay.
Updates and reorders operations on
ipfs --help
to prioritize 'dag' and 'files' over legacy 'object'Context: Deprecate Object API #7936
Clarifies that
ipfs object
only 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