Patch documentation #4903
Merged
Patch documentation #4903
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joeldierkes
requested review from
bari12,
bziemons and
mlassnig
as code owners
|
Hi! My understanding of dry runs is that they succeed (exit code 0), if everything would run fine. Instead of this change, I would suggest adding a |
joeldierkes
force-pushed
the
patch-documentation
branch
from
0249417
to
84d738a
Compare
If a header in a python file is modified, the `tools/add_header` script with the `--check` argument will now return a non-zero exit code. This means that `tools/add_header` can be used as a pre-commit check or inside the CI/CD.
joeldierkes
force-pushed
the
patch-documentation
branch
from
84d738a
to
4b1e366
Compare
|
Good idea! |
mlassnig
approved these changes
Oct 20, 2021
bziemons
approved these changes
Oct 20, 2021
bari12
pushed a commit
that referenced
this pull request
Oct 22, 2021
* Api: Enhance documentation * Documentation: Return a non-zero exit code for modified header If a header in a python file is modified, the `tools/add_header` script with the `--check` argument will now return a non-zero exit code. This means that `tools/add_header` can be used as a pre-commit check or inside the CI/CD.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Api: Enhance Documentation
Documentation: Return a non-zero exit code for modified header
If a header in a python file is modified, the
tools/add_headerscript with thedry-runargument will now return a non-zero exit code. This means thattools/add_headercan be used as a pre-commit check or inside the CI/CD.