Muspi Merol a1a536b2c5 Normalize inconsistent markdown headings in docstrings (#16364) ... I am working on a project that uses ruff linters' docs to generate a fine-tuning dataset for LLMs. To achieve this, I first ran the command `ruff rule --all --output-format json` to retrieve all the rules. Then, I parsed the explanation field to get these 3 consistent sections: - `Why is this bad?` - `What it does` - `Example` However, during the initial processing, I noticed that the markdown headings are not that consistent. For instance: - In most cases, `Use instead` appears as a normal paragraph within the `Example` section, but in the file `crates/ruff_linter/src/rules/flake8_bandit/rules/django_extra.rs` it is a level-2 heading - The heading "What it does**?**" is used in some places, while others consistently use "What it does" - There are 831 `Example` headings and 65 `Examples`. But all of them only have one example case This PR normalized these across all rules. ## Test Plan CI are passed.		2025-02-25 15:42:55 +05:30
..
red_knot	[red-knot] Add argfile and windows glob path support (#16353)	2025-02-25 08:43:13 +01:00
red_knot_project	Rename venv-path to python (#16347)	2025-02-24 19:41:06 +01:00
red_knot_python_semantic	[red-knot] Better diagnostics for method calls (#16362)	2025-02-25 09:58:08 +01:00
red_knot_server	add diagnostic Span (couples File and TextRange) (#16101)	2025-02-11 14:55:12 -05:00
red_knot_test	Rename venv-path to python (#16347)	2025-02-24 19:41:06 +01:00
red_knot_vendored	Sync vendored typeshed stubs (#16173)	2025-02-15 10:01:34 +00:00
red_knot_wasm	Use ast::PythonVersion internally in the formatter and linter (#16170)	2025-02-18 12:03:13 -05:00
ruff	Add per-file-target-version option (#16257)	2025-02-24 08:47:13 -05:00
ruff_annotate_snippets	Fix docstring in ruff_annotate_snippets (#15748)	2025-01-26 22:25:29 -05:00
ruff_benchmark	[red-knot] Add diagnostic for class-object access to pure instance variables (#16036)	2025-02-24 15:17:16 +01:00
ruff_cache	Fix cache key collisions for paths with separators (#12159)	2024-07-03 07:36:46 -05:00
ruff_db	[red-knot] Prefix Type::call and dunder_call with try (#16261)	2025-02-20 09:05:04 +00:00
ruff_dev	Pass ParserOptions to the parser (#16220)	2025-02-19 10:50:50 -05:00
ruff_diagnostics	Show errors for attempted fixes only when passed --verbose (#15237)	2025-01-03 08:50:13 -06:00
ruff_formatter	Upgrade Rust toolchain to 1.84.0 (#15408)	2025-01-11 09:51:58 +01:00
ruff_graph	Pass ParserOptions to the parser (#16220)	2025-02-19 10:50:50 -05:00
ruff_index	Transition to salsa coarse-grained tracked structs (#15763)	2025-02-11 11:38:50 +01:00
ruff_linter	Normalize inconsistent markdown headings in docstrings (#16364)	2025-02-25 15:42:55 +05:30
ruff_macros	Add knot.toml schema (#15735)	2025-02-07 10:59:40 +01:00
ruff_notebook	Update Rust crate rand to 0.9.0 (#15899)	2025-02-03 12:25:57 +01:00
ruff_python_ast	[flake8-self] Ignore attribute accesses on instance-like variables (SLF001) (#16149)	2025-02-23 10:00:49 +00:00
ruff_python_ast_integration_tests	Pass ParserOptions to the parser (#16220)	2025-02-19 10:50:50 -05:00
ruff_python_codegen	Pass ParserOptions to the parser (#16220)	2025-02-19 10:50:50 -05:00
ruff_python_formatter	Rename ExprStringLiteral::as_unconcatenated_string() to ExprStringLiteral::as_single_part_string() (#16253)	2025-02-19 16:06:57 +00:00
ruff_python_index	Extract LineIndex independent methods from Locator (#13938)	2024-10-28 07:53:41 +00:00
ruff_python_literal	Preserve triple quotes and prefixes for strings (#15818)	2025-02-04 08:41:06 -05:00
ruff_python_parser	Rename ExprStringLiteral::as_unconcatenated_string() to ExprStringLiteral::as_single_part_string() (#16253)	2025-02-19 16:06:57 +00:00
ruff_python_resolver	Update insta snapshots (#14366)	2024-11-15 19:31:15 +01:00
ruff_python_semantic	[flake8-self] Ignore attribute accesses on instance-like variables (SLF001) (#16149)	2025-02-23 10:00:49 +00:00
ruff_python_stdlib	Revert "Add all PEP-585 names to UP006 rule" (#15250)	2025-01-04 12:23:53 +01:00
ruff_python_trivia	[red-knot] Hand-written MDTest parser (#15926)	2025-02-04 14:01:53 +01:00
ruff_python_trivia_integration_tests	Pass ParserOptions to the parser (#16220)	2025-02-19 10:50:50 -05:00
ruff_server	Add per-file-target-version option (#16257)	2025-02-24 08:47:13 -05:00
ruff_source_file	[pyupgrade] Do not report when a UTF-8 comment is followed by a non-UTF-8 one (UP009) (#14728)	2024-12-11 10:30:41 +00:00
ruff_text_size	[ruff] itertools.starmap(..., zip(...)) (RUF058) (#15483)	2025-01-16 15:18:12 +01:00
ruff_wasm	Add per-file-target-version option (#16257)	2025-02-24 08:47:13 -05:00
ruff_workspace	Add per-file-target-version option (#16257)	2025-02-24 08:47:13 -05:00