Skip to content
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

Merged
merged 2 commits into from
Mar 18, 2022

Conversation

schomatis
Copy link
Contributor

@schomatis schomatis commented Feb 1, 2022

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.

@lidel lidel force-pushed the schomatis/feat/cmds-status branch from e8e23f7 to afaf21a Compare March 18, 2022 22:16
lidel added a commit to ipfs/kubo that referenced this pull request Mar 18, 2022
Added programmatic state annotation introduced in
ipfs/go-ipfs-cmds#225
for already deprecated / experimental commands.
lidel added a commit to ipfs/ipfs-docs that referenced this pull request Mar 18, 2022
Leverages Status field from
ipfs/go-ipfs-cmds#225
ipfs/kubo#8802
and uses that information while generating HTTP RPC API reference docs.
Copy link
Member

@lidel lidel left a 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 👌

Comment on lines +502 to +507
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"
Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, looks fair.

@schomatis schomatis merged commit 3797716 into master Mar 18, 2022
@schomatis schomatis deleted the schomatis/feat/cmds-status branch March 18, 2022 23:03
lidel added a commit to ipfs/kubo that referenced this pull request Mar 22, 2022
* 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>
lidel added a commit to ipfs/ipfs-docs that referenced this pull request Apr 21, 2022
Leverages Status field from
ipfs/go-ipfs-cmds#225
ipfs/kubo#8802
and uses that information while generating HTTP RPC API reference docs.
lidel added a commit to ipfs/ipfs-docs that referenced this pull request Apr 21, 2022
Leverages Status field from
ipfs/go-ipfs-cmds#225
ipfs/kubo#8802
and uses that information while generating HTTP RPC API reference docs.
hannahhoward pushed a commit to filecoin-project/kubo-api-client that referenced this pull request Jun 19, 2023
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Deprecated flags/options
3 participants