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

[engsys] docs,fix: --root is required for tox run -e black #38751

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

kdestin
Copy link
Member

@kdestin kdestin commented Dec 2, 2024

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 running tox run -e black.

cc: @scbedd

Background

tox run -e black used to be a thin wrapper around an invocation of black, 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 the dev-requirements.txt in a package's root directory, which makes it mandatory to specify --root now.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@kdestin kdestin enabled auto-merge (squash) December 2, 2024 21:36
Copy link
Member

@scbedd scbedd left a comment

Choose a reason for hiding this comment

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

You're absolutely right thanks for the catch @kdestin

@kdestin kdestin merged commit c67103e into Azure:main Dec 2, 2024
21 checks passed
l0lawrence pushed a commit to l0lawrence/azure-sdk-for-python that referenced this pull request Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants