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

add words to warn users some tools are unimplemented so far #261

Open
ceblanton opened this issue Nov 8, 2024 · 0 comments
Open

add words to warn users some tools are unimplemented so far #261

ceblanton opened this issue Nov 8, 2024 · 0 comments

Comments

@ceblanton
Copy link
Collaborator

We (@ilaflott , @singhd789 , @chanwilson ) have agreed that we should add some words to the click help messages to warn users that some tools are unimplemented.

c2b:~%>fre --help  
Usage: fre [OPTIONS] COMMAND [ARGS]...

  'fre' is the main CLI click group that houses the other tool groups as
  lazy subcommands.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  app         - access fre app subcommands
  catalog     - access fre catalog subcommands
  check       - access fre check subcommands
  cmor        - access fre cmor subcommands
  list        - access fre list subcommands
  make        - access fre make subcommands
  pp          - access fre pp subcommands
  run         - access fre run subcommands
  test        - access fre test subcommands
  yamltools   - access fre yamltools subcommands

Ian suggested we raise "not yet implemented" exception for those tools if we haven't yet.

Chan suggested "UNDER CONSTRUCTION" words.

Dana pointed to the exact spot for the changes

@click.group(help=click.style(" - access fre make subcommands", fg=(210,73,57))) --> @click.group(help=click.style(" - UNDER CONSTRUCTION", fg=(210,73,57)))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant