ruff/crates/ruff_python_formatter/src
Andrew Gallant b6fb972e6f
config: add new `docstring-code-format` knob (#8854)
This PR does the plumbing to make a new formatting option,
`docstring-code-format`, available in the configuration for end users.
It is disabled by default (opt-in). It is opt-in at least initially to
reflect a conservative posture. The intent is to make it opt-out at some
point in the future.

This was split out from #8811 in order to make #8811 easier to merge.
Namely, once this is merged, docstring code snippet formatting will
become available to end users. (See comments below for how we arrived at
the name.)

Closes #7146

## Test Plan

Other than the standard test suite, I ran the formatter over the CPython
and polars projects to ensure both that the result looked sensible and
that tests still passed. At time of writing, one issue that currently
appears is that reformatting code snippets trips the long line lint:
https://github.com/BurntSushi/polars/actions/runs/7006619426/job/19058868021
2023-12-13 11:02:11 -05:00
..
comments remove several uses of `unsafe` (#8600) 2023-11-28 09:50:03 -05:00
expression Add `as_slice` method for all string nodes (#9111) 2023-12-13 06:31:20 +00:00
module Attach dangling comments to the comprehension instead of the `if` or `iter` nodes (#7693) 2023-09-29 10:45:01 +01:00
other Avoid trailing comma for single-argument with positional separator (#9076) 2023-12-09 18:03:31 -05:00
pattern New `Singleton` enum for `PatternMatchSingleton` node (#8063) 2023-10-30 05:48:53 +00:00
snapshots Remove exception-handler lexing from `unused-bound-exception` fix (#5851) 2023-07-18 18:27:46 +00:00
statement `prefer_splitting_right_hand_side_of_assignments` preview style (#8943) 2023-12-13 03:43:23 +00:00
type_param Don't move type param opening parenthesis comment (#8163) 2023-10-24 12:02:27 +00:00
builders.rs Implement multiline dictionary and list hugging for preview style (#8293) 2023-11-30 21:11:14 -05:00
cli.rs Add `--skip-magic-trailing-comma` to formatter dev comment (#8689) 2023-11-15 09:23:46 +00:00
context.rs ruff_python_formatter: implement "dynamic" line width mode for docstring code formatting (#9098) 2023-12-12 09:58:07 -05:00
generated.rs New AST nodes for f-string elements (#8835) 2023-12-07 10:28:05 -06:00
lib.rs ruff_python_formatter: implement "dynamic" line width mode for docstring code formatting (#9098) 2023-12-12 09:58:07 -05:00
main.rs Formatter and parser refactoring (#7569) 2023-09-26 15:29:43 +02:00
options.rs config: add new `docstring-code-format` knob (#8854) 2023-12-13 11:02:11 -05:00
prelude.rs Accept any `Into<AnyNodeRef>` as `Comments` arguments (#5205) 2023-06-20 16:49:21 +00:00
preview.rs `prefer_splitting_right_hand_side_of_assignments` preview style (#8943) 2023-12-13 03:43:23 +00:00
shared_traits.rs ruff_python_formatter: copy and inline shared traits (#8656) 2023-11-13 12:16:04 -05:00
verbatim.rs Preserve trailing semicolons when using `fmt: off` (#8275) 2023-10-30 00:22:34 +00:00