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

Improve the description of --check about exit status #1579

Closed
akihironitta opened this issue Oct 25, 2020 · 0 comments · Fixed by #1590
Closed

Improve the description of --check about exit status #1579

akihironitta opened this issue Oct 25, 2020 · 0 comments · Fixed by #1590
Labels
documentation Improvements or additions to documentation

Comments

@akihironitta
Copy link
Contributor

akihironitta commented Oct 25, 2020

I am using isort --check --diff on GitHub Actions for my project, and I would like to suggest to add a statement about unix exit status of --check option as black has.

isort -h has no statement about exit status:

  -c, --check-only, --check
                        Checks the file for unsorted / unformatted imports and
                        prints them to the command line without modifying the
                        file.

while black -h clearly describes the exit status code:

  --check                         Don't write the files back, just return the
                                  status.  Return code 0 means nothing would
                                  change.  Return code 1 means some files
                                  would be reformatted.  Return code 123 means
                                  there was an internal error.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants