[engsys] docs,fix: --root
is required for tox run -e black
#38751
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.
Description
This pull request updates
eng_sys_checks.md
to specify that the--root
parameter needs to point to a package's root directory when runningtox run -e black
.cc: @scbedd
Background
tox run -e black
used to be a thin wrapper around an invocation ofblack
, which meant we didn't need to specify--root
so long as positional arguments could be forwarded to the underlying invocation of black.#38212 updated
tox run -e black
to instead run a script which invokes black. The script depends on thedev-requirements.txt
in a package's root directory, which makes it mandatory to specify--root
now.All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines