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

CLI helptext cleanup into --help and --help-long #9035

Open
lidel opened this issue Jun 10, 2022 · 0 comments
Open

CLI helptext cleanup into --help and --help-long #9035

lidel opened this issue Jun 10, 2022 · 0 comments
Labels
kind/enhancement A net-new feature or improvement to an existing feature topic/commands Topic commands topic/docs Documentation

Comments

@lidel
Copy link
Member

lidel commented Jun 10, 2022

Note from GO triage:

  • Our command descriptions are not leveraging ShortDescription and LongDescription to the fullest
  • LongDescription is often too long for --help, for example ipfs add --help – see Expand rolling chunker documentation #8952

Proposed cleanup

Audit all commands and make sure each has a reasonable short and log description.

Desired UX would be:

  • enhance the way we use https://github.com/ipfs/go-ipfs-cmds/ to support --help and --help-long
  • ipfs foo --help should print ShortDescription
    • if LongDescription is present, ShortDescription should have a footer saying "For more information pass --help-long"
    • ipfs foo --help-long should print LongDescription is present, and fallback to ShortDescription otherwise

https://docs.ipfs.io/reference/api/cli/ would default to --help-long

@lidel lidel added kind/enhancement A net-new feature or improvement to an existing feature topic/commands Topic commands topic/docs Documentation labels Jun 10, 2022
@lidel lidel added this to the Best Effort Track milestone Jun 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement A net-new feature or improvement to an existing feature topic/commands Topic commands topic/docs Documentation
Projects
No open projects
Status: 🥞 Todo
Development

No branches or pull requests

1 participant