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

describe requires-python fallback in docs #16704

Merged
merged 5 commits into from
Mar 13, 2025
Merged

Conversation

dylwil3
Copy link
Collaborator

@dylwil3 dylwil3 commented Mar 13, 2025

Adds description of requires-python fallback to documentation for configuration file discovery.

@dylwil3 dylwil3 added the documentation Improvements or additions to documentation label Mar 13, 2025
@dylwil3 dylwil3 added this to the v0.10 milestone Mar 13, 2025
@dylwil3 dylwil3 requested review from MichaReiser and ntBre March 13, 2025 12:22
Copy link

codspeed-hq bot commented Mar 13, 2025

CodSpeed Performance Report

Merging #16704 will not alter performance

Comparing dylwil3:config-docs (8da82b6) with main (abaa189)

Summary

✅ 32 untouched benchmarks

Copy link
Contributor

github-actions bot commented Mar 13, 2025

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

Copy link
Member

@MichaReiser MichaReiser left a comment

Choose a reason for hiding this comment

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

Thanks, this looks good

@MichaReiser
Copy link
Member

I'll change the base. We can merge this directly into main.

@MichaReiser MichaReiser changed the base branch from micha/ruff-0.10 to main March 13, 2025 12:50
@MichaReiser MichaReiser changed the base branch from main to micha/ruff-0.10 March 13, 2025 12:50
@MichaReiser MichaReiser changed the base branch from micha/ruff-0.10 to main March 13, 2025 12:55
Copy link
Contributor

@ntBre ntBre left a comment

Choose a reason for hiding this comment

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

This looks great, and thanks for adding the subsection!

My only quibble is with the second rule. It seems slightly confusing to me, but I think it would be too verbose to try to add ruff.toml (or especially a list of file options) in place of each "configuration[ file]" occurrence to clarify things.

Co-authored-by: Brent Westbrook <[email protected]>
@dylwil3
Copy link
Collaborator Author

dylwil3 commented Mar 13, 2025

My only quibble is with the second rule. It seems slightly confusing to me, but I think it would be too verbose to try to add ruff.toml (or especially a list of file options) in place of each "configuration[ file]" occurrence to clarify things.

Yeah I agree it's a bit awkward, but I can't think of a better way to word it at the moment. It's especially confusing because the found configuration file could itself be a pyproject.toml, just one that's missing both requires-python and target-version.

@ntBre
Copy link
Contributor

ntBre commented Mar 13, 2025

Agreed, I think it's good for now. We can iterate if users actually get confused.

@dylwil3 dylwil3 merged commit b9b2562 into astral-sh:main Mar 13, 2025
21 checks passed
dcreager added a commit that referenced this pull request Mar 14, 2025
* main: (53 commits)
  [syntax-errors] Tuple unpacking in `for` statement iterator clause before Python 3.9 (#16558)
  Ruff v0.10 Release (#16708)
  Add new `noqa` specification to the docs (#16703)
  describe requires-python fallback in docs (#16704)
  [red-knot] handle cycles in MRO/bases resolution (#16693)
  [red-knot] Auto generate statement nodes (#16645)
  [`pylint`] Better inference for `str.strip` (`PLE310`) (#16671)
  [`pylint`] Improve `repeated-equality-comparison` fix to use a `set` when all elements are hashable (`PLR1714`) (#16685)
  [`pylint`/`pep8-naming`] Check `__new__` argument name in `bad-staticmethod-argument` and not `invalid-first-argument-name-for-class-method` (`PLW0211`/`N804`) (#16676)
  [`flake8-pyi`] Stabilize fix for `unused-private-type-var` (`PYI018`) (#16682)
  [`flake8-bandit`] Deprecate `suspicious-xmle-tree-usage` (`S320`) (#16680)
  [`flake8-simplify`] Avoid double negation in fixes (`SIM103`) (#16684)
  [`pyupgrade`]: Improve diagnostic range for `redundant-open-mode` (`UP015`) (#16672)
  Consider all `TYPE_CHECKING` symbols for type-checking blocks (#16669)
  [`pep8-naming`]: Ignore methods decorated with `@typing.override` (`invalid-argument-name`) (#16667)
  Stabilize FURB169 preview behavior (#16666)
  [`pylint`] Detect invalid default value type for `os.environ.get` (`PLW1508`) (#16674)
  [`flake8-pytest-style`] Allow for loops with empty bodies (`PT012`, `PT031`) (#16678)
  [`pyupgrade`]: Deprecate `non-pep604-isinstance` (`UP038`) (#16681)
  [`flake8-type-checking`] Stabilize `runtime-cast-value` (`TC006`) (#16637)
  ...
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
Development

Successfully merging this pull request may close these issues.

3 participants