-
Notifications
You must be signed in to change notification settings - Fork 42
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
feat(Command): add status for the helptext #225
Conversation
e8e23f7
to
afaf21a
Compare
Added programmatic state annotation introduced in ipfs/go-ipfs-cmds#225 for already deprecated / experimental commands.
Leverages Status field from ipfs/go-ipfs-cmds#225 ipfs/kubo#8802 and uses that information while generating HTTP RPC API reference docs.
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.
Thank you @schomatis, I took it for a spin in ipfs/kubo#8802 and ipfs/ipfs-docs#1086, and it works perfectly 👌
case cmds.Deprecated: | ||
return "DEPRECATED, command will be removed in the future" | ||
case cmds.Experimental: | ||
return "EXPERIMENTAL, command may change in future releases" | ||
case cmds.Removed: | ||
return "REMOVED, command is no longer available" |
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.
IF this text looks ok, then we can merge and ship this.
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.
Yep, looks fair.
* feat(cmds): add deprecated and experimental status Added programmatic state annotation introduced in ipfs/go-ipfs-cmds#225 for already deprecated / experimental commands. * chore: go-ipfs-cmds v0.7.0 Co-authored-by: Lucas Molas <schomatis@gmail.com>
Leverages Status field from ipfs/go-ipfs-cmds#225 ipfs/kubo#8802 and uses that information while generating HTTP RPC API reference docs.
Leverages Status field from ipfs/go-ipfs-cmds#225 ipfs/kubo#8802 and uses that information while generating HTTP RPC API reference docs.
* feat(cmds): add deprecated and experimental status Added programmatic state annotation introduced in ipfs/go-ipfs-cmds#225 for already deprecated / experimental commands. * chore: go-ipfs-cmds v0.7.0 Co-authored-by: Lucas Molas <schomatis@gmail.com>
The logic of this patch is trivial; this review is more about adjusting to the desired presentation (if there are aesthetic changes needed an example of the desired output would be useful).
Closes #93.