Support formatting pycon markdown code blocks#23112
Merged
Conversation
Member
Author
|
Still needs tests |
|
ntBre
reviewed
Feb 6, 2026
Contributor
ntBre
left a comment
ntBre
left a comment
There was a problem hiding this comment.
I wan to take a closer look at how this works in the docstring formatting, but this looks plausible to me in general.
Typing conformance resultsNo changes detected ✅ |
|
ntBre
approved these changes
Feb 6, 2026
Contributor
ntBre
left a comment
ntBre
left a comment
There was a problem hiding this comment.
I managed to come up with a few nits, but this looks good to me overall. The main things I'm worried about are the trailing whitespace and the ruff_formatter dependency (sorry again about that one!).
|
|
||
| let offset = FIRST_LINE.text_len(); | ||
| let mut changed = false; | ||
| let mut result = String::with_capacity(source.len()); |
Contributor
There was a problem hiding this comment.
We might actually want to skip this with_capacity call since String::new() won't allocate at all in the case that nothing changes and we're able to return None.
Member
Author
There was a problem hiding this comment.
Should I do the same thing in format_code_blocks above? Is there a way to "initialize with full capacity only once needed"?
Contributor
There was a problem hiding this comment.
It's probably not a big deal either way, but yeah I guess you could do the same in format_code_blocks. I don't think there's a nice way to initialize only if needed. There's reserve, but that's not quite the same.
I think it's fine to leave this as-is.
crates/ruff_markdown/src/lib.rs
Outdated
Comment on lines
159
to
167
| while let Some(next_line) = lines.peek() { | ||
| if next_line.starts_with(CONTINUATION) { | ||
| end = next_line.full_end(); | ||
| unformatted.push_str(&source[TextRange::new(next_line.start() + offset, end)]); | ||
| lines.next(); | ||
| } else { | ||
| break; | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
Suggested change
| while let Some(next_line) = lines.peek() { | |
| if next_line.starts_with(CONTINUATION) { | |
| end = next_line.full_end(); | |
| unformatted.push_str(&source[TextRange::new(next_line.start() + offset, end)]); | |
| lines.next(); | |
| } else { | |
| break; | |
| } | |
| } | |
| while let Some(next_line) = lines.next_if(|line| line.starts_with(CONTINUATION)) { | |
| end = next_line.full_end(); | |
| unformatted.push_str(&source[TextRange::new(next_line.start() + offset, end)]); | |
| } |
I think you can simplify this slightly with the next_if helper.
Member
Author
There was a problem hiding this comment.
I'm not sure if I like this as much once I had to add logic to deal with empty continuation lines (ie, no space after the "...") 🤔
What do you think? 257b0ae
Contributor
There was a problem hiding this comment.
That commit looks fine to me! What don't you like about it?
Member
Author
There was a problem hiding this comment.
mostly that it didn't feel "simpler" at this point, but ¯_(ツ)_/¯
ntBre
added
formatter
carljm
added a commit
to Hugo-Polloli/ruff
that referenced
this pull request
Feb 9, 2026
* main: (45 commits) [ty] Fix wrong inlay hints for overloaded function arguments (astral-sh#23179) [ty] Respect `@no_type_check` when combined with other decorators (astral-sh#23177) [ty] Use type context when inferring constructor argument types (astral-sh#23139) [`airflow`] Add ruff rules to catch deprecated attribute access from context key for Airflow 3.0 (`AIR301`) (astral-sh#22850) Support formatting `pycon` markdown code blocks (astral-sh#23112) Markdown formatting in LSP (astral-sh#23063) Instruct Claude to use comments more sparingly (astral-sh#23181) [`flake8-gettext`] Fix false negatives for plural argument of ngettext (`INT001`, `INT002`, `INT003`) (astral-sh#21078) [ty] Invoking goto-def on parentheses of a class constructor call takes you too constructor method [ty] Make goto definition on class constructor always go to class definition [ty] Assign lower completions ranking to deprecated functions and classes (astral-sh#23089) [ty] Fix parameter references across files via keyword args (astral-sh#23012) [ty] Exclude enclosing class for base completions (astral-sh#23141) [`pyupgrade`] Fix syntax error on string with newline escape and comment (`UP037`) (astral-sh#22968) [ty] Improve documentation for `expect_single_definition` method (astral-sh#23175) [ty] Configure check mode for all projects Add `home-assistant` to ecosystem projects (astral-sh#23132) Add tabbed shell completion documentation (astral-sh#23169) Bump typing conformance-suite pin (astral-sh#23174) [ty] Fix invalid diagnostic location for a sub-call to a specialized ParamSpec (astral-sh#23036) ...
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fix #23078