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

imp : improve help text #62

Merged
merged 4 commits into from
Nov 21, 2023
Merged

imp : improve help text #62

merged 4 commits into from
Nov 21, 2023

Conversation

abhijeetSaroha
Copy link
Collaborator

change the output text to this.

positional arguments:
  target
    Specify the target command to be performed. Options are:
    
    default:
    --------
      default.clean => Clean unnecessary temporary files
    
    docs:
    -----
      docs.build => Build documentation
      docs.preview => Preview documentation page locally
    
    release:
    --------
      release.ci => Run semantic release on CI
      release.dry => Run semantic release in dry-run mode
    
    tests:
    ------
      tests.linter => Run linter tools
      tests.unittest => Run tests
      tests.smoke => Run smoke tests
      tests.ci => Run all targets used on CI
    
    smoke-tests:
    ------------
      smoke-tests.simple => Test makim using a simple makimfile
        ARGS:
          --verbose-mode: (bool) Run the all the tests in verbose mode
      smoke-tests.complex => Test makim using a complex makimfile
        ARGS:
          --verbose-mode: (bool) Run the all the tests in verbose mode
      smoke-tests.containers => Test makim with containers-sugar
        ARGS:
          --verbose-mode: (bool) Run the all the tests in verbose mode
      smoke-tests.unittest => Test makim using a unittest makimfile
        ARGS:
          --verbose-mode: (bool) Run the all the tests in verbose mode
      smoke-tests.vars-env => Test makim using env makimfile
        ARGS:
          --verbose-mode: (bool) Run the all the tests in verbose mode
      smoke-tests.bash => ...

makim/cli.py Outdated
@@ -119,8 +121,7 @@ def _get_args():
nargs='?',
default=None,
help=(
'Specify the target command to be performed. '
'\nOptions are:\n' + '\n'.join(target_help)
'Specify the target command to be performed. Options are:\n' + '\n'.join(target_help)
Copy link
Member

Choose a reason for hiding this comment

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

this line is very long (~86 characters).
please use pre-commit locally to identify and fix this issue:

pre-commit install
pre-commit run --all-files

remember to check if you have all your dependencies updated: poetry install

Copy link
Member

Choose a reason for hiding this comment

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

ping me if you have any questions

@xmnlab
Copy link
Member

xmnlab commented Nov 20, 2023

the output looks really nice!

@abhijeetSaroha abhijeetSaroha changed the title WIP : improve help text imp : improve help text Nov 21, 2023
@xmnlab xmnlab merged commit e14b963 into osl-incubator:main Nov 21, 2023
8 checks passed
@xmnlab
Copy link
Member

xmnlab commented Nov 21, 2023

looks good to me. thanks @abhijeetSaroha for working on that.

@abhijeetSaroha abhijeetSaroha deleted the abhijeet-branch branch November 23, 2023 14:20
Copy link

github-actions bot commented Dec 8, 2023

🎉 This PR is included in version 1.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

2 participants