10BC0 fix(hover): unify horizontal rule formatting to `---` by skewb1k · Pull Request #20379 · rust-lang/rust-analyzer · GitHub
[go: up one dir, main page]

Skip to content

Conversation

skewb1k
Copy link
Contributor
@skewb1k skewb1k commented Aug 4, 2025

Currently, hover documentation uses both ___ and --- as horizontal rule delimiters. While both styles are valid according to the GitHub Flavored Markdown Spec, the mixed usage seems accidental to me.

This PR change all horizontal breaks to --- because it is less ambiguous and already more common in rust-analyzer than ___.

I also believe that such consistency makes the code and tests a bit easier to maintain.

Replaces all `___` with `---` in hover documentation markups.

Both styles are valid per the GitHub Flavored Markdown spec,
but `---` is less ambiguous and already more widely used in rust-analyzer
@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 4, 2025
Copy link
Contributor
@ChayimFriedman2 ChayimFriedman2 left a comment

Choose a reason for hiding this comment

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

I don't know if this is better but it's also not worse.

Thanks!

@ChayimFriedman2 ChayimFriedman2 added this pull request to the merge queue Sep 17, 2025
Merged via the queue into rust-lang:master with commit 78bb458 Sep 17, 2025
15 checks passed
@rustbot rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0