mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-28 04:45:01 +00:00
a5f41e8d63
## Summary The purpose of this change is mainly to address one of the issues outlined in #10427. Namely, some lists in the docs were not rendering properly when preceded by a text block without a newline character. This PR adds `mdformat` as a final step to the rule documentation script, so that any missing newlines will be added. NB: The default behavior of `mdformat` is to escape markdown special characters found in text such as `<`. This resulted in some misformatted docs. To address this I implemented an ad-hoc mdformat plugin to override the behavior. This may be considered a bit 'hacky', but I think it's a good solution. Nevertheless, if someone has a better idea, let me know. ## Test Plan This change is hard to test systematically, however, I tried my best to look at the before and after diffs to ensure no unwanted changes were made to the docs.
8 lines
153 B
Text
8 lines
153 B
Text
PyYAML==6.0.1
|
|
black==23.10.0
|
|
mkdocs==1.5.0
|
|
mkdocs-material==9.1.18
|
|
mkdocs-redirects==1.2.1
|
|
mdformat==0.7.17
|
|
mdformat-mkdocs==2.0.4
|
|
mdformat-admon==2.0.2
|