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

[utils] Turn on the help arg option in micro.py #560

Open
TieWay59 opened this issue Jul 11, 2022 · 3 comments
Open

[utils] Turn on the help arg option in micro.py #560

TieWay59 opened this issue Jul 11, 2022 · 3 comments
Labels
enhancement good first issue Good issue for first-time contributors

Comments

@TieWay59
Copy link
Contributor

I think removing this config (the add_help is set True by default) won't do any harm and will make users feel easier to read into these descriptions.

parser = argparse.ArgumentParser(add_help=False)

This line is last modified 4 years ago shipped along with the micro.py itself, see #190 5882e58.

And the add_help is originally turned off by some intention, but as a newbie, I've found it helpful if I can just run micro.py -h to see all the arg details as below:

usage: micro.py [-h] [--raw] [--enrich] [--identities-load]
                [--identities-merge] [--panels] [--cfg CFG_PATH]
                [--backends [BACKEND_SECTIONS [BACKEND_SECTIONS ...]]]
                [--repos [REPOS_TO_CHECK [REPOS_TO_CHECK ...]]]
                [--logs-dir LOGS_DIR]

optional arguments:
  -h, --help            show this help message and exit
  --raw                 Activate raw task
  --enrich              Activate enrich task
  --identities-load     Activate load identities task
  --identities-merge    Activate merge identities task
  --panels              Activate panels task
  --cfg CFG_PATH        Configuration file path
  --backends [BACKEND_SECTIONS [BACKEND_SECTIONS ...]]
                        Backend sections to execute
  --repos [REPOS_TO_CHECK [REPOS_TO_CHECK ...]]
                        Limit which repositories are processed (list of URLs)
  --logs-dir LOGS_DIR   Logs Directory

@vchrombie @valeriocos Did I miss any details or I would issue a PR to fix that.

@Pablohn26
Copy link

I agree with you @TieWay59 , setting it to True (by default) would be helpful for newbies. I do not understand why it is set to False.

@vchrombie
Copy link
Member

Hi @TieWay59, thanks for opening the issue. Thanks, @Pablohn26 for your feedback.

I'm unaware of why it was turned off but even I think it would be helpful to turn it on. @TieWay59, please feel free to open a PR.

Thank you.

@jjmerchante jjmerchante added enhancement good first issue Good issue for first-time contributors labels Oct 13, 2023
@Anmollenka
Copy link

Hi @vchrombie ,Can I work on this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement good first issue Good issue for first-time contributors
Projects
None yet
Development

No branches or pull requests

5 participants