mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-10-08 17:41:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Avoid reformatting comments in rules reference documentation (#19093)

Browse source 
closes https://github.com/astral-sh/ty/issues/754
This commit is contained in:
Zanie Blue 2025-07-02 10:16:44 -05:00 • committed by GitHub
parent 4cf56d7ad4
commit efd9b75352
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

9
crates/ruff_dev/src/generate_ty_rules.rs
View file

@ -73,11 +73,16 @@ fn generate_markdown() -> String {
for lint in lints {
let _ = writeln!(&mut output, "## `{rule_name}`\n", rule_name = lint.name());
// Increase the header-level by one
// Reformat headers as bold text
let mut in_code_fence = false;
let documentation = lint
.documentation_lines()
.map(|line| {
if line.starts_with('#') {
// Toggle the code fence state if we encounter a boundary
if line.starts_with("```") {
in_code_fence = !in_code_fence;
}
if !in_code_fence && line.starts_with('#') {
Cow::Owned(format!(
"**{line}**\n",
line = line.trim_start_matches('#').trim_start()