Document find_project_root ignoring pyproject.toml without [tool.black]
#4425
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
meliache
force-pushed
the
document-find-project-root-ignoring-pyproject-toml-without-black-section
branch
2 times, most recently
from
637b919
to
b5bf52d
Compare
JelleZijlstra
added
the
skip news
Extend the docstring of black's `find_project_root` to mention that it ignores `pyproject.toml` files without a `[tool.black]` section. This is relevant because that function is also used by other python packages that use black. I found that e.g. datamodel-code-generator [1] uses that function and that there the ignoring of the pyproject.toml files lead to a degradation [2]. I think in that case it would be better to not use black's function for finding the pyproject.toml, but in any case this behavior should be documented. 1: https://github.com/koxudaxi/datamodel-code-generator 2: koxudaxi/datamodel-code-generator#2052
meliache
force-pushed
the
document-find-project-root-ignoring-pyproject-toml-without-black-section
branch
from
b5bf52d
to
c6b7a4c
Compare
JelleZijlstra
approved these changes
Aug 2, 2024
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.
Description
Extend the docstring of black's
find_project_rootto mention that it ignorespyproject.tomlfiles without a[tool.black]section.This is relevant because that function is also used by other python packages that use black. I found that e.g. datamodel-code-generator uses that function and that there the ignoring of the pyproject.toml files lead to a degradation. I think in that case it would be better to not use black's function for finding the pyproject.toml, but in any case this behavior should be documented.
Checklist - did you ...