Skip to content

[ty] Replace markdown hard line breaks in snapshot tests#24361

Merged
MichaReiser merged 1 commit intomainfrom
micha/hover-docstring-markdown-line-breaks
Apr 2, 2026
Merged

[ty] Replace markdown hard line breaks in snapshot tests#24361
MichaReiser merged 1 commit intomainfrom
micha/hover-docstring-markdown-line-breaks

Conversation

@MichaReiser
Copy link
Copy Markdown
Member

Summary

Our markdown docstring rendering uses \n to force a hard line break.
Some editors trim the two spaces before the newline in snapshot tests which
is pretty annoying when working on those files.

This PR replaces the \n in snapshots with an explicit <HB> marker which editors don't trim.
It also makes it more explicit that the trailing whitespace is intentional.

Test Plan

cargo test

@MichaReiser MichaReiser added testing Related to testing Ruff itself ty Multi-file analysis & type inference labels Apr 2, 2026
@MichaReiser MichaReiser merged commit 68483b3 into main Apr 2, 2026
48 checks passed
@MichaReiser MichaReiser deleted the micha/hover-docstring-markdown-line-breaks branch April 2, 2026 12:03
carljm added a commit that referenced this pull request Apr 2, 2026
* main:
  Add a "release-gate" step to the release workflow (#24365)
  Disallow starred expressions as values of starred expressions (#24280)
  [`pyupgrade`] Ignore strings with string-only escapes (`UP012`) (#16058)
  [ty] Improve consistency and quality of diagnostics relating to invalid type forms (#24325)
  [flake8-type-checking] Clarify import cycle wording for TC001/TC002/TC003 (#24322)
  [`flake8-errmsg`] Avoid shadowing existing `msg` in fix for `EM101` (#24363)
  `RUF072`: skip formfeeds on dedent (#24308)
  Replace unmaintained `unic-ucd-category` crate with `icu_properties` (#24344)
  [ty] Replace markdown hard line breaks in snapshot tests (#24361)
  [ty] Move snapshot for code action test with trailing whitespace to external file (#24359)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testing Related to testing Ruff itself ty Multi-file analysis & type inference

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants