Skip to content

Document markdown formatting feature#22990

Merged
amyreese merged 4 commits intomainfrom
amy/document-markdown-formatting
Feb 3, 2026
Merged

Document markdown formatting feature#22990
amyreese merged 4 commits intomainfrom
amy/document-markdown-formatting

Conversation

@amyreese
Copy link
Copy Markdown
Member

No description provided.

@amyreese amyreese requested review from BurntSushi, dylwil3 and ntBre and removed request for BurntSushi January 30, 2026 20:23
@amyreese amyreese added the documentation Improvements or additions to documentation label Jan 30, 2026
Copy link
Copy Markdown
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.

Nice! Just a couple of small nits, and I think I might have learned a new Markdown link syntax 😆

Comment thread docs/formatter.md Outdated
Comment thread docs/formatter.md Outdated
Comment thread docs/formatter.md Outdated
Comment thread docs/formatter.md
ntBre added a commit that referenced this pull request Feb 2, 2026
Summary
--

I noticed this while reviewing #22990

Test Plan
--
Copy link
Copy Markdown
Collaborator

@dylwil3 dylwil3 left a comment

Choose a reason for hiding this comment

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

Nice!

Comment thread docs/formatter.md Outdated
Comment on lines +268 to +272
While in preview release, Ruff will not automatically find and format Markdown
files in your project, but will format any Markdown files directly passed as
an argument. To include Markdown files when running Ruff on your project,
add them with [`extend-include`](settings.md#extend-include) in your
project settings:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think this could be reworded a bit.

First a nit: remove "While in preview release" since this is stated already at the beginning and end of this documentation.

But mainly: I think folks might not necessarily guess what happens if they do something like ruff format docs/ where docs/ has only Markdown files.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I mostly put the "while in preview" part to imply that the behavior is likely to change once we stabilize the feature.

Comment thread docs/formatter.md Outdated

## Markdown code formatting

*Formatting for Markdown code blocks is currently only available in [preview mode](preview.md#preview).*
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
*Formatting for Markdown code blocks is currently only available in [preview mode](preview.md#preview).*
*Formatting for code blocks in Markdown files is currently only available in [preview mode](preview.md#preview).*

Comment thread docs/formatter.md Outdated

*Formatting for Markdown code blocks is currently only available in [preview mode](preview.md#preview).*

The Ruff formatter can also format Markdown files with a `.md` extension.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is a little misleading, even though it is clarified in the next sentence, since it makes it seem like Ruff formats the whole markdown file, not just the Python code inside it.

Also I think the .md extension clause is unnecessary, though technically correct - in the same way that a Python file need not have a .py (etc.) ending, but that is how we discover them. We still just say "Python files". You could clarify later that they are discovered via the .md extension (and sort of do say that later on anyway).

Comment thread docs/formatter.md
```toml
[tool.ruff]
# Find and format code blocks in Markdown files
extend-include = ["*.md"]
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just to clarify, something like extend-include = ["docs/*.md"] also works as expected, but extend-include = ["docs/*"] does nothing?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it's fine for this glob not to end with *.md, but I did have to check:

~/astral/worktrees/ruff1/target/debug/ruff format --check --no-cache --config 'extend-include=["*"]' --preview
unformatted: File would be reformatted
 --> try.md:1:1
1 | ```py
  - import  math
2 + import math
3 | ```

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The extension needs to be included, otherwise ruff will also discover other files that aren't python/markdown/toml, and will end up trying to format them as python:

$ ruff format --check --preview --config 'extend-include=["docs/*"]' docs/ | grep -C1 extra.js
invalid-syntax: Simple statements must be separated by newlines or semicolons
--> docs/js/extra.js:1:1

@amyreese
Copy link
Copy Markdown
Member Author

amyreese commented Feb 2, 2026

Reworded some bits to reduce repetition, moved the mention of .md extension further down, added an example of how discovery works atm, and explicitly clarified that this behavior is likely to change once the feature is stabilized.

@amyreese amyreese requested review from dylwil3 and ntBre February 2, 2026 19:59
ntBre added a commit that referenced this pull request Feb 2, 2026
Summary
--

I noticed this while reviewing #22990. I'm not really sure why the
current version doesn't work, but the new one definitely does.

Test Plan
--

[Before](https://docs.astral.sh/ruff/formatter/#docstring-formatting):

<img width="457" height="77" alt="image"
src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fastral-sh%2Fruff%2Fpull%2F%3Ca+href%3D"https://github.com/user-attachments/assets/3d4394b7-eadf-41ec-81c9-cea6190fa0bb">https://github.com/user-attachments/assets/3d4394b7-eadf-41ec-81c9-cea6190fa0bb"
/>


After:

<img width="493" height="84" alt="image"
src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fastral-sh%2Fruff%2Fpull%2F%3Ca+href%3D"https://github.com/user-attachments/assets/66f0700c-9312-40b9-b3ae-11edcaec7562">https://github.com/user-attachments/assets/66f0700c-9312-40b9-b3ae-11edcaec7562"
/>
@ntBre ntBre mentioned this pull request Feb 3, 2026
@amyreese amyreese enabled auto-merge (squash) February 3, 2026 16:56
@amyreese amyreese disabled auto-merge February 3, 2026 16:57
@amyreese amyreese merged commit e65f9a6 into main Feb 3, 2026
39 checks passed
@amyreese amyreese deleted the amy/document-markdown-formatting branch February 3, 2026 16:58
nicopauss pushed a commit to Intersec/lib-common that referenced this pull request Apr 1, 2026
Released on 2026-03-19.

- Display output severity in preview ([#23845](astral-sh/ruff#23845))
- Don't show `noqa` hover for non-Python documents ([#24040](astral-sh/ruff#24040))

- \[`pycodestyle`] Recognize `pyrefly:` as a pragma comment (`E501`) ([#24019](astral-sh/ruff#24019))

- Don't return code actions for non-Python documents ([#23905](astral-sh/ruff#23905))

- Add company AI policy to contributing guide ([#24021](astral-sh/ruff#24021))
- Document editor features for Markdown code formatting ([#23924](astral-sh/ruff#23924))
- \[`pylint`] Improve phrasing (`PLC0208`) ([#24033](astral-sh/ruff#24033))

- Use PEP 639 license information ([#19661](astral-sh/ruff#19661))

- [@tmimmanuel](https://github.com/tmimmanuel)
- [@DimitriPapadopoulos](https://github.com/DimitriPapadopoulos)
- [@amyreese](https://github.com/amyreese)
- [@statxc](https://github.com/statxc)
- [@dylwil3](https://github.com/dylwil3)
- [@hunterhogan](https://github.com/hunterhogan)
- [@renovate](https://github.com/renovate)

Released on 2026-03-12.

- Add support for `lazy` import parsing ([#23755](astral-sh/ruff#23755))
- Add support for star-unpacking of comprehensions (PEP 798) ([#23788](astral-sh/ruff#23788))
- Reject semantic syntax errors for lazy imports ([#23757](astral-sh/ruff#23757))
- Drop a few rules from the preview default set ([#23879](astral-sh/ruff#23879))
- \[`airflow`] Flag `Variable.get()` calls outside of task execution context (`AIR003`) ([#23584](astral-sh/ruff#23584))
- \[`airflow`] Flag runtime-varying values in DAG/task constructor arguments (`AIR304`) ([#23631](astral-sh/ruff#23631))
- \[`flake8-bugbear`] Implement `delattr-with-constant` (`B043`) ([#23737](astral-sh/ruff#23737))
- \[`flake8-tidy-imports`] Add `TID254` to enforce lazy imports ([#23777](astral-sh/ruff#23777))
- \[`flake8-tidy-imports`] Allow users to ban lazy imports with `TID254` ([#23847](astral-sh/ruff#23847))
- \[`isort`] Retain `lazy` keyword when sorting imports ([#23762](astral-sh/ruff#23762))
- \[`pyupgrade`] Add `from __future__ import annotations` automatically (`UP006`) ([#23260](astral-sh/ruff#23260))
- \[`refurb`] Support `newline` parameter in `FURB101` for Python 3.13+ ([#23754](astral-sh/ruff#23754))
- \[`ruff`] Add `os-path-commonprefix` (`RUF071`) ([#23814](astral-sh/ruff#23814))
- \[`ruff`] Add unsafe fix for os-path-commonprefix (`RUF071`) ([#23852](astral-sh/ruff#23852))
- \[`ruff`] Limit `RUF036` to typing contexts; make it unsafe for non-typing-only ([#23765](astral-sh/ruff#23765))
- \[`ruff`] Use starred unpacking for `RUF017` in Python 3.15+ ([#23789](astral-sh/ruff#23789))

- Fix `--add-noqa` creating unwanted leading whitespace ([#23773](astral-sh/ruff#23773))
- Fix `--add-noqa` breaking shebangs ([#23577](astral-sh/ruff#23577))
- \[formatter] Fix lambda body formatting for multiline calls and subscripts ([#23866](astral-sh/ruff#23866))
- \[formatter] Preserve required annotation parentheses in annotated assignments ([#23865](astral-sh/ruff#23865))
- \[formatter] Preserve type-expression parentheses in the formatter ([#23867](astral-sh/ruff#23867))
- \[`flake8-annotations`] Fix stack overflow in `ANN401` on quoted annotations with escape sequences ([#23912](astral-sh/ruff#23912))
- \[`pep8-naming`] Check naming conventions in `match` pattern bindings (`N806`, `N815`, `N816`) ([#23899](astral-sh/ruff#23899))
- \[`perflint`] Fix comment duplication in fixes (`PERF401`, `PERF403`) ([#23729](astral-sh/ruff#23729))
- \[`pyupgrade`] Properly trigger `super` change in nested class (`UP008`) ([#22677](astral-sh/ruff#22677))
- \[`ruff`] Avoid syntax errors in `RUF036` fixes ([#23764](astral-sh/ruff#23764))

- \[`flake8-bandit`] Flag `S501` with `requests.request` ([#23873](astral-sh/ruff#23873))
- \[`flake8-executable`] Fix WSL detection in non-Docker containers ([#22879](astral-sh/ruff#22879))
- \[`flake8-print`] Ignore `pprint` calls with `stream=` ([#23787](astral-sh/ruff#23787))

- Update docs for Markdown code block formatting ([#23871](astral-sh/ruff#23871))
- \[`flake8-bugbear`] Fix misleading description for `B904` ([#23731](astral-sh/ruff#23731))

- [@zsol](https://github.com/zsol)
- [@carljm](https://github.com/carljm)
- [@ntBre](https://github.com/ntBre)
- [@Bortlesboat](https://github.com/Bortlesboat)
- [@sososonia-cyber](https://github.com/sososonia-cyber)
- [@chirizxc](https://github.com/chirizxc)
- [@leandrobbraga](https://github.com/leandrobbraga)
- [@11happy](https://github.com/11happy)
- [@Acelogic](https://github.com/Acelogic)
- [@anishgirianish](https://github.com/anishgirianish)
- [@amyreese](https://github.com/amyreese)
- [@xvchris](https://github.com/xvchris)
- [@charliermarsh](https://github.com/charliermarsh)
- [@getehen](https://github.com/getehen)
- [@Dev-iL](https://github.com/Dev-iL)

Released on 2026-03-05.

- Discover Markdown files by default in preview mode ([#23434](astral-sh/ruff#23434))
- \[`perflint`] Extend `PERF102` to comprehensions and generators ([#23473](astral-sh/ruff#23473))
- \[`refurb`] Fix `FURB101` and `FURB103` false positives when I/O variable is used later ([#23542](astral-sh/ruff#23542))
- \[`ruff`] Add fix for `none-not-at-end-of-union` (`RUF036`) ([#22829](astral-sh/ruff#22829))
- \[`ruff`] Fix false positive for `re.split` with empty string pattern (`RUF055`) ([#23634](astral-sh/ruff#23634))

- \[`fastapi`] Handle callable class dependencies with `__call__` method (`FAST003`) ([#23553](astral-sh/ruff#23553))
- \[`pydocstyle`] Fix numpy section ordering (`D420`) ([#23685](astral-sh/ruff#23685))
- \[`pyflakes`] Fix false positive for names shadowing re-exports (`F811`) ([#23356](astral-sh/ruff#23356))
- \[`pyupgrade`] Avoid inserting redundant `None` elements in `UP045` ([#23459](astral-sh/ruff#23459))

- Document extension mapping for Markdown code formatting ([#23574](astral-sh/ruff#23574))
- Update default Python version examples ([#23605](astral-sh/ruff#23605))

- Publish releases to Astral mirror ([#23616](astral-sh/ruff#23616))

- [@amyreese](https://github.com/amyreese)
- [@stakeswky](https://github.com/stakeswky)
- [@chirizxc](https://github.com/chirizxc)
- [@anishgirianish](https://github.com/anishgirianish)
- [@bxff](https://github.com/bxff)
- [@zsol](https://github.com/zsol)
- [@charliermarsh](https://github.com/charliermarsh)
- [@ntBre](https://github.com/ntBre)
- [@kar-ganap](https://github.com/kar-ganap)

Released on 2026-02-26.

This is a follow-up release to 0.15.3 that resolves a panic when the new rule `PLR1712` was enabled with any rule that analyzes definitions, such as many of the `ANN` or `D` rules.

- Fix panic on access to definitions after analyzing definitions ([#23588](astral-sh/ruff#23588))
- \[`pyflakes`] Suppress false positive in `F821` for names used before `del` in stub files ([#23550](astral-sh/ruff#23550))

- Clarify first-party import detection in Ruff ([#23591](astral-sh/ruff#23591))
- Fix incorrect `import-heading` example ([#23568](astral-sh/ruff#23568))

- [@stakeswky](https://github.com/stakeswky)
- [@ntBre](https://github.com/ntBre)
- [@thejcannon](https://github.com/thejcannon)
- [@GeObts](https://github.com/GeObts)

Released on 2026-02-26.

- Drop explicit support for `.qmd` file extension ([#23572](astral-sh/ruff#23572))

  This can now be enabled instead by setting the [`extension`](https://docs.astral.sh/ruff/settings/#extension) option:

  ```toml
  # ruff.toml
  extension = { qmd = "markdown" }

  # pyproject.toml
  [tool.ruff]
  extension = { qmd = "markdown" }
  ```

- Include configured extensions in file discovery ([#23400](astral-sh/ruff#23400))

- \[`flake8-bandit`] Allow suspicious imports in `TYPE_CHECKING` blocks (`S401`-`S415`) ([#23441](astral-sh/ruff#23441))

- \[`flake8-bugbear`] Allow `B901` in pytest hook wrappers ([#21931](astral-sh/ruff#21931))

- \[`flake8-import-conventions`] Add missing conventions from upstream (`ICN001`, `ICN002`) ([#21373](astral-sh/ruff#21373))

- \[`pydocstyle`] Add rule to enforce docstring section ordering (`D420`) ([#23537](astral-sh/ruff#23537))

- \[`pylint`] Implement `swap-with-temporary-variable` (`PLR1712`) ([#22205](astral-sh/ruff#22205))

- \[`ruff`] Add `unnecessary-assign-before-yield` (`RUF070`) ([#23300](astral-sh/ruff#23300))

- \[`ruff`] Support file-level noqa in `RUF102` ([#23535](astral-sh/ruff#23535))

- \[`ruff`] Suppress diagnostic for invalid f-strings before Python 3.12 (`RUF027`) ([#23480](astral-sh/ruff#23480))

- \[`flake8-bandit`] Don't flag `BaseLoader`/`CBaseLoader` as unsafe (`S506`) ([#23510](astral-sh/ruff#23510))

- Avoid infinite loop between `I002` and `PYI025` ([#23352](astral-sh/ruff#23352))
- \[`pyflakes`] Fix false positive for `@overload` from `lint.typing-modules` (`F811`) ([#23357](astral-sh/ruff#23357))
- \[`pyupgrade`] Fix false positive for `TypeVar` default before Python 3.12 (`UP046`) ([#23540](astral-sh/ruff#23540))
- \[`pyupgrade`] Fix handling of `\N` in raw strings (`UP032`) ([#22149](astral-sh/ruff#22149))

- Render sub-diagnostics in the GitHub output format ([#23455](astral-sh/ruff#23455))

- \[`flake8-bugbear`] Tag certain `B007` diagnostics as unnecessary ([#23453](astral-sh/ruff#23453))

- \[`ruff`] Ignore unknown rule codes in `RUF100` ([#23531](astral-sh/ruff#23531))

  These are now flagged by [`RUF102`](https://docs.astral.sh/ruff/rules/invalid-rule-code/) instead.

- Fix missing settings links for several linters ([#23519](astral-sh/ruff#23519))
- Update isort action comments heading ([#23515](astral-sh/ruff#23515))
- \[`pydocstyle`] Fix double comma in description of `D404` ([#23440](astral-sh/ruff#23440))

- Update the Python module (notably `find_ruff_bin`) for parity with uv ([#23406](astral-sh/ruff#23406))

- [@zanieb](https://github.com/zanieb)
- [@o1x3](https://github.com/o1x3)
- [@assadyousuf](https://github.com/assadyousuf)
- [@kar-ganap](https://github.com/kar-ganap)
- [@denyszhak](https://github.com/denyszhak)
- [@amyreese](https://github.com/amyreese)
- [@carljm](https://github.com/carljm)
- [@anishgirianish](https://github.com/anishgirianish)
- [@Bnyro](https://github.com/Bnyro)
- [@danparizher](https://github.com/danparizher)
- [@ntBre](https://github.com/ntBre)
- [@gcomneno](https://github.com/gcomneno)
- [@jaap3](https://github.com/jaap3)
- [@stakeswky](https://github.com/stakeswky)

Released on 2026-02-19.

- Expand the default rule set ([#23385](astral-sh/ruff#23385))

  In preview, Ruff now enables a significantly expanded default rule set of 412
  rules, up from the stable default set of 59 rules. The new rules are mostly a
  superset of the stable defaults, with the exception of these rules, which are
  removed from the preview defaults:

  - [`multiple-imports-on-one-line`](https://docs.astral.sh/ruff/rules/multiple-imports-on-one-line) (`E401`)
  - [`module-import-not-at-top-of-file`](https://docs.astral.sh/ruff/rules/module-import-not-at-top-of-file) (`E402`)
  - [`module-import-not-at-top-of-file`](https://docs.astral.sh/ruff/rules/module-import-not-at-top-of-file) (`E701`)
  - [`multiple-statements-on-one-line-semicolon`](https://docs.astral.sh/ruff/rules/multiple-statements-on-one-line-semicolon) (`E702`)
  - [`useless-semicolon`](https://docs.astral.sh/ruff/rules/useless-semicolon) (`E703`)
  - [`none-comparison`](https://docs.astral.sh/ruff/rules/none-comparison) (`E711`)
  - [`true-false-comparison`](https://docs.astral.sh/ruff/rules/true-false-comparison) (`E712`)
  - [`not-in-test`](https://docs.astral.sh/ruff/rules/not-in-test) (`E713`)
  - [`not-is-test`](https://docs.astral.sh/ruff/rules/not-is-test) (`E714`)
  - [`type-comparison`](https://docs.astral.sh/ruff/rules/type-comparison) (`E721`)
  - [`lambda-assignment`](https://docs.astral.sh/ruff/rules/lambda-assignment) (`E731`)
  - [`ambiguous-variable-name`](https://docs.astral.sh/ruff/rules/ambiguous-variable-name) (`E741`)
  - [`ambiguous-class-name`](https://docs.astral.sh/ruff/rules/ambiguous-class-name) (`E742`)
  - [`ambiguous-function-name`](https://docs.astral.sh/ruff/rules/ambiguous-function-name) (`E743`)
  - [`undefined-local-with-import-star`](https://docs.astral.sh/ruff/rules/undefined-local-with-import-star) (`F403`)
  - [`undefined-local-with-import-star-usage`](https://docs.astral.sh/ruff/rules/undefined-local-with-import-star-usage) (`F405`)
  - [`undefined-local-with-nested-import-star-usage`](https://docs.astral.sh/ruff/rules/undefined-local-with-nested-import-star-usage) (`F406`)
  - [`forward-annotation-syntax-error`](https://docs.astral.sh/ruff/rules/forward-annotation-syntax-error) (`F722`)

  If you use preview and prefer the old defaults, you can restore them with
  configuration like:

  ```toml

  # ruff.toml

  [lint]
  select = ["E4", "E7", "E9", "F"]

  # pyproject.toml

  [tool.ruff.lint]
  select = ["E4", "E7", "E9", "F"]
  ```

  If you do give them a try, feel free to share your feedback in the [GitHub
  discussion](astral-sh/ruff#23203)!

- \[`flake8-pyi`] Also check string annotations (`PYI041`) ([#19023](astral-sh/ruff#19023))

- \[`flake8-async`] Fix `in_async_context` logic ([#23426](astral-sh/ruff#23426))
- \[`ruff`] Fix for `RUF102` should delete entire comment ([#23380](astral-sh/ruff#23380))
- \[`ruff`] Suppress diagnostic for strings with backslashes in interpolations before Python 3.12 (`RUF027`) ([#21069](astral-sh/ruff#21069))
- \[`flake8-bugbear`] Fix `B023` false positive for immediately-invoked lambdas ([#23294](astral-sh/ruff#23294))
- \[parser] Fix false syntax error for match-like annotated assignments ([#23297](astral-sh/ruff#23297))
- \[parser] Fix indentation tracking after line continuations ([#23417](astral-sh/ruff#23417))

- \[`flake8-executable`] Allow global flags in uv shebangs (`EXE003`) ([#22582](astral-sh/ruff#22582))
- \[`pyupgrade`] Fix handling of `typing.{io,re}` (`UP035`) ([#23131](astral-sh/ruff#23131))
- \[`ruff`] Detect `PLC0207` on chained `str.split()` calls ([#23275](astral-sh/ruff#23275))

- Remove invalid inline `noqa` warning ([#23270](astral-sh/ruff#23270))

- Add extension mapping to configuration file options ([#23384](astral-sh/ruff#23384))

- Add `Q004` to the list of conflicting rules ([#23340](astral-sh/ruff#23340))
- \[`ruff`] Expand `lint.external` docs and add sub-diagnostic (`RUF100`, `RUF102`) ([#23268](astral-sh/ruff#23268))

- [@dylwil3](https://github.com/dylwil3)
- [@Jkhall81](https://github.com/Jkhall81)
- [@danparizher](https://github.com/danparizher)
- [@dhruvmanila](https://github.com/dhruvmanila)
- [@harupy](https://github.com/harupy)
- [@ngnpope](https://github.com/ngnpope)
- [@amyreese](https://github.com/amyreese)
- [@kar-ganap](https://github.com/kar-ganap)
- [@robsdedude](https://github.com/robsdedude)
- [@shaanmajid](https://github.com/shaanmajid)
- [@ntBre](https://github.com/ntBre)
- [@toslunar](https://github.com/toslunar)

Released on 2026-02-12.

- \[`airflow`] Add ruff rules to catch deprecated Airflow imports for Airflow 3.1 (`AIR321`) ([#22376](astral-sh/ruff#22376))
- \[`airflow`] Third positional parameter not named `ti_key` should be flagged for `BaseOperatorLink.get_link` (`AIR303`) ([#22828](astral-sh/ruff#22828))
- \[`flake8-gettext`] Fix false negatives for plural argument of `ngettext` (`INT001`, `INT002`, `INT003`) ([#21078](astral-sh/ruff#21078))
- \[`pyflakes`] Fix infinite loop in preview fix for `unused-import` (`F401`) ([#23038](astral-sh/ruff#23038))
- \[`pygrep-hooks`] Detect non-existent mock methods in standalone expressions (`PGH005`) ([#22830](astral-sh/ruff#22830))
- \[`pylint`] Allow dunder submodules and improve diagnostic range (`PLC2701`) ([#22804](astral-sh/ruff#22804))
- \[`pyupgrade`] Improve diagnostic range for tuples (`UP024`) ([#23013](astral-sh/ruff#23013))
- \[`refurb`] Check subscripts in tuple do not use lambda parameters in `reimplemented-operator` (`FURB118`) ([#23079](astral-sh/ruff#23079))
- \[`ruff`] Detect mutable defaults in `field` calls (`RUF008`) ([#23046](astral-sh/ruff#23046))
- \[`ruff`] Ignore std `cmath.inf` (`RUF069`) ([#23120](astral-sh/ruff#23120))
- \[`ruff`] New rule `float-equality-comparison` (`RUF069`) ([#20585](astral-sh/ruff#20585))
- Don't format unlabeled Markdown code blocks ([#23106](astral-sh/ruff#23106))
- Markdown formatting support in LSP ([#23063](astral-sh/ruff#23063))
- Support Quarto Markdown language markers ([#22947](astral-sh/ruff#22947))
- Support formatting `pycon` Markdown code blocks ([#23112](astral-sh/ruff#23112))
- Use extension mapping to select Markdown code block language ([#22934](astral-sh/ruff#22934))

- Avoid false positive for undefined variables in `FAST001` ([#23224](astral-sh/ruff#23224))
- Avoid introducing syntax errors for `FAST003` autofix ([#23227](astral-sh/ruff#23227))
- Avoid suggesting `InitVar` for `__post_init__` that references PEP 695 type parameters ([#23226](astral-sh/ruff#23226))
- Deduplicate type variables in generic functions ([#23225](astral-sh/ruff#23225))
- Fix exception handler parenthesis removal for Python 3.14+ ([#23126](astral-sh/ruff#23126))
- Fix f-string middle panic when parsing t-strings ([#23232](astral-sh/ruff#23232))
- Wrap `RUF020` target for multiline fixes ([#23210](astral-sh/ruff#23210))
- Wrap `UP007` target for multiline fixes ([#23208](astral-sh/ruff#23208))
- Fix missing diagnostics for last range suppression in file ([#23242](astral-sh/ruff#23242))
- \[`pyupgrade`] Fix syntax error on string with newline escape and comment (`UP037`) ([#22968](astral-sh/ruff#22968))

- Use `ruff` instead of `Ruff` as the program name in GitHub output format ([#23240](astral-sh/ruff#23240))
- \[`PT006`] Fix syntax error when unpacking nested tuples in `parametrize` fixes ([#22441](astral-sh/ruff#22441)) ([#22464](astral-sh/ruff#22464))
- \[`airflow`] Catch deprecated attribute access from context key for Airflow 3.0 (`AIR301`) ([#22850](astral-sh/ruff#22850))
- \[`airflow`] Capture deprecated arguments and a decorator (`AIR301`) ([#23170](astral-sh/ruff#23170))
- \[`flake8-boolean-trap`] Add `multiprocessing.Value` to excluded functions for `FBT003` ([#23010](astral-sh/ruff#23010))
- \[`flake8-bugbear`] Add a secondary annotation showing the previous occurrence (`B033`) ([#22634](astral-sh/ruff#22634))
- \[`flake8-type-checking`] Add sub-diagnostic showing the runtime use of an annotation (`TC004`) ([#23091](astral-sh/ruff#23091))
- \[`isort`] Support configurable import section heading comments ([#23151](astral-sh/ruff#23151))
- \[`ruff`] Improve the diagnostic for `RUF012` ([#23202](astral-sh/ruff#23202))

- Suppress diagnostic output for `format --check --silent` ([#17736](astral-sh/ruff#17736))

- Add tabbed shell completion documentation ([#23169](astral-sh/ruff#23169))
- Explain how to enable Markdown formatting for pre-commit hook ([#23077](astral-sh/ruff#23077))
- Fixed import in `runtime-evaluated-decorators` example ([#23187](astral-sh/ruff#23187))
- Update ruff server contributing guide ([#23060](astral-sh/ruff#23060))

- Exclude WASM artifacts from GitHub releases ([#23221](astral-sh/ruff#23221))

- [@mkniewallner](https://github.com/mkniewallner)
- [@bxff](https://github.com/bxff)
- [@dylwil3](https://github.com/dylwil3)
- [@Avasam](https://github.com/Avasam)
- [@amyreese](https://github.com/amyreese)
- [@charliermarsh](https://github.com/charliermarsh)
- [@Alex-ley-scrub](https://github.com/Alex-ley-scrub)
- [@Kalmaegi](https://github.com/Kalmaegi)
- [@danparizher](https://github.com/danparizher)
- [@AiyionPrime](https://github.com/AiyionPrime)
- [@eureka928](https://github.com/eureka928)
- [@11happy](https://github.com/11happy)
- [@Jkhall81](https://github.com/Jkhall81)
- [@chirizxc](https://github.com/chirizxc)
- [@leandrobbraga](https://github.com/leandrobbraga)
- [@tvatter](https://github.com/tvatter)
- [@anishgirianish](https://github.com/anishgirianish)
- [@shaanmajid](https://github.com/shaanmajid)
- [@ntBre](https://github.com/ntBre)
- [@sjyangkevin](https://github.com/sjyangkevin)

Released on 2026-02-03.

Check out the [blog post](https://astral.sh/blog/ruff-v0.15.0) for a migration
guide and overview of the changes!

- Ruff now formats your code according to the 2026 style guide. See the formatter section below or in the blog post for a detailed list of changes.

- The linter now supports block suppression comments. For example, to suppress `N803` for all parameters in this function:

  ```python
  # ruff: disable[N803]
  def foo(
      legacyArg1,
      legacyArg2,
      legacyArg3,
      legacyArg4,
  ): ...
  # ruff: enable[N803]
  ```

  See the [documentation](https://docs.astral.sh/ruff/linter/#block-level) for more details.

- The `ruff:alpine` Docker image is now based on Alpine 3.23 (up from 3.21).

- The `ruff:debian` and `ruff:debian-slim` Docker images are now based on Debian 13 "Trixie" instead of Debian 12 "Bookworm."

- Binaries for the `ppc64` (64-bit big-endian PowerPC) architecture are no longer included in our releases. It should still be possible to build Ruff manually for this platform, if needed.

- Ruff now resolves all `extend`ed configuration files before falling back on a default Python version.

The following rules have been stabilized and are no longer in preview:

- [`blocking-http-call-httpx-in-async-function`](https://docs.astral.sh/ruff/rules/blocking-http-call-httpx-in-async-function)
  (`ASYNC212`)
- [`blocking-path-method-in-async-function`](https://docs.astral.sh/ruff/rules/blocking-path-method-in-async-function)
  (`ASYNC240`)
- [`blocking-input-in-async-function`](https://docs.astral.sh/ruff/rules/blocking-input-in-async-function)
  (`ASYNC250`)
- [`map-without-explicit-strict`](https://docs.astral.sh/ruff/rules/map-without-explicit-strict)
  (`B912`)
- [`if-exp-instead-of-or-operator`](https://docs.astral.sh/ruff/rules/if-exp-instead-of-or-operator)
  (`FURB110`)
- [`single-item-membership-test`](https://docs.astral.sh/ruff/rules/single-item-membership-test)
  (`FURB171`)
- [`missing-maxsplit-arg`](https://docs.astral.sh/ruff/rules/missing-maxsplit-arg) (`PLC0207`)
- [`unnecessary-lambda`](https://docs.astral.sh/ruff/rules/unnecessary-lambda) (`PLW0108`)
- [`unnecessary-empty-iterable-within-deque-call`](https://docs.astral.sh/ruff/rules/unnecessary-empty-iterable-within-deque-call)
  (`RUF037`)
- [`in-empty-collection`](https://docs.astral.sh/ruff/rules/in-empty-collection) (`RUF060`)
- [`legacy-form-pytest-raises`](https://docs.astral.sh/ruff/rules/legacy-form-pytest-raises)
  (`RUF061`)
- [`non-octal-permissions`](https://docs.astral.sh/ruff/rules/non-octal-permissions) (`RUF064`)
- [`invalid-rule-code`](https://docs.astral.sh/ruff/rules/invalid-rule-code) (`RUF102`)
- [`invalid-suppression-comment`](https://docs.astral.sh/ruff/rules/invalid-suppression-comment)
  (`RUF103`)
- [`unmatched-suppression-comment`](https://docs.astral.sh/ruff/rules/unmatched-suppression-comment)
  (`RUF104`)
- [`replace-str-enum`](https://docs.astral.sh/ruff/rules/replace-str-enum) (`UP042`)

The following behaviors have been stabilized:

- The `--output-format` flag is now respected when running Ruff in `--watch` mode, and the `full` output format is now used by default, matching the regular CLI output.
- [`builtin-attribute-shadowing`](https://docs.astral.sh/ruff/rules/builtin-attribute-shadowing/) (`A003`) now detects the use of shadowed built-in names in additional contexts like decorators, default arguments, and other attribute definitions.
- [`duplicate-union-member`](https://docs.astral.sh/ruff/rules/duplicate-union-member/) (`PYI016`) now considers `typing.Optional` when searching for duplicate union members.
- [`split-static-string`](https://docs.astral.sh/ruff/rules/split-static-string/) (`SIM905`) now offers an autofix when the `maxsplit` argument is provided, even without a `sep` argument.
- [`dict-get-with-none-default`](https://docs.astral.sh/ruff/rules/dict-get-with-none-default/) (`SIM910`) now applies to more types of key expressions.
- [`super-call-with-parameters`](https://docs.astral.sh/ruff/rules/super-call-with-parameters/) (`UP008`) now has a safe fix when it will not delete comments.
- [`unnecessary-default-type-args`](https://docs.astral.sh/ruff/rules/unnecessary-default-type-args/) (`UP043`) now applies to stub (`.pyi`) files on Python versions before 3.13.

This release introduces the new 2026 style guide, with the following changes:

- Lambda parameters are now kept on the same line and lambda bodies will be parenthesized to let
  them break across multiple lines ([#21385](astral-sh/ruff#21385))
- Parentheses around tuples of exceptions in `except` clauses will now be removed on Python 3.14 and
  later ([#20768](astral-sh/ruff#20768))
- A single empty line is now permitted at the beginning of function bodies ([#21110](astral-sh/ruff#21110))
- Parentheses are avoided for long `as` captures in `match` statements ([#21176](astral-sh/ruff#21176))
- Extra spaces between escaped quotes and ending triple quotes can now be omitted ([#17216](astral-sh/ruff#17216))
- Blank lines are now enforced before classes with decorators in stub files ([#18888](astral-sh/ruff#18888))

- Apply formatting to Markdown code blocks ([#22470](astral-sh/ruff#22470), [#22990](astral-sh/ruff#22990), [#22996](astral-sh/ruff#22996))

  See the [documentation](https://docs.astral.sh/ruff/formatter/#markdown-code-formatting) for more details.

- Fix suppression indentation matching ([#22903](astral-sh/ruff#22903))

- Customize where the `fix_title` sub-diagnostic appears ([#23044](astral-sh/ruff#23044))
- \[`FastAPI`] Add sub-diagnostic explaining why a fix was unavailable (`FAST002`) ([#22565](astral-sh/ruff#22565))
- \[`flake8-annotations`] Don't suggest `NoReturn` for functions raising `NotImplementedError` (`ANN201`, `ANN202`, `ANN205`, `ANN206`) ([#21311](astral-sh/ruff#21311))
- \[`pyupgrade`] Make fix unsafe if it deletes comments (`UP017`) ([#22873](astral-sh/ruff#22873))
- \[`pyupgrade`] Make fix unsafe if it deletes comments (`UP020`) ([#22872](astral-sh/ruff#22872))
- \[`pyupgrade`] Make fix unsafe if it deletes comments (`UP033`) ([#22871](astral-sh/ruff#22871))
- \[`refurb`] Do not add `abc.ABC` if already present (`FURB180`) ([#22234](astral-sh/ruff#22234))
- \[`refurb`] Make fix unsafe if it deletes comments (`FURB110`) ([#22768](astral-sh/ruff#22768))
- \[`ruff`] Add sub-diagnostics with permissions (`RUF064`) ([#22972](astral-sh/ruff#22972))

- Identify notebooks by LSP `didOpen` instead of `.ipynb` file extension ([#22810](astral-sh/ruff#22810))

- Add `--color` CLI option to force colored output ([#22806](astral-sh/ruff#22806))

- Document `-` stdin convention in CLI help text ([#22817](astral-sh/ruff#22817))
- \[`refurb`] Change example to `re.search` with `^` anchor (`FURB167`) ([#22984](astral-sh/ruff#22984))
- Fix link to Sphinx code block directives ([#23041](astral-sh/ruff#23041))
- \[`pydocstyle`] Clarify which quote styles are allowed (`D300`) ([#22825](astral-sh/ruff#22825))
- \[`flake8-bugbear`] Improve docs for `no-explicit-stacklevel` (`B028`) ([#22538](astral-sh/ruff#22538))

- Update MSRV to 1.91 ([#22874](astral-sh/ruff#22874))

- [@danparizher](https://github.com/danparizher)
- [@chirizxc](https://github.com/chirizxc)
- [@amyreese](https://github.com/amyreese)
- [@Jkhall81](https://github.com/Jkhall81)
- [@cwkang1998](https://github.com/cwkang1998)
- [@manzt](https://github.com/manzt)
- [@11happy](https://github.com/11happy)
- [@hugovk](https://github.com/hugovk)
- [@caiquejjx](https://github.com/caiquejjx)
- [@ntBre](https://github.com/ntBre)
- [@akawd](https://github.com/akawd)
- [@konstin](https://github.com/konstin)

Renovate-Branch: renovate/2024.6-ruff-0.x
Change-Id: I8f8e865435fde1fc736fe2528261a604acb46215
Priv-Id: f7e1d99008e3617149c4b639a9a2bbc06212d064
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.

4 participants