Normalize inconsistent markdown headings in docstrings#16364
Merged
dhruvmanila merged 3 commits intoastral-sh:mainfrom Feb 25, 2025
CNSeniorious000:docstring-consistency
Merged
Normalize inconsistent markdown headings in docstrings#16364dhruvmanila merged 3 commits intoastral-sh:mainfrom CNSeniorious000:docstring-consistency
dhruvmanila merged 3 commits intoastral-sh:mainfrom
CNSeniorious000:docstring-consistency
Conversation
dhruvmanila
approved these changes
Feb 25, 2025
Member
dhruvmanila
left a comment
dhruvmanila
left a comment
There was a problem hiding this comment.
Thank you for doing this!
Contributor
|
Contributor
Author
|
Thank you for the quick review and merge! |
dcreager
added a commit
that referenced
this pull request
Feb 25, 2025
* main: (38 commits) [red-knot] Use arena-allocated association lists for narrowing constraints (#16306) [red-knot] Rewrite `Type::try_iterate()` to improve type inference and diagnostic messages (#16321) Add issue templates (#16213) Normalize inconsistent markdown headings in docstrings (#16364) [red-knot] Better diagnostics for method calls (#16362) [red-knot] Add argfile and windows glob path support (#16353) [red-knot] Handle pipe-errors gracefully (#16354) Rename `venv-path` to `python` (#16347) [red-knot] Fixup some formatting in `infer.rs` (#16348) [red-knot] Restrict visibility of more things in `class.rs` (#16346) [red-knot] Add diagnostic for class-object access to pure instance variables (#16036) Add `per-file-target-version` option (#16257) [PLW1507] Mark fix unsafe (#16343) [red-knot] Add a test to ensure that `KnownClass::try_from_file_and_name()` is kept up to date (#16326) Extract class and instance types (#16337) Re-order changelog entries for 0.9.7 (#16344) [red-knot] Add support for `@classmethod`s (#16305) Update Salsa (#16338) Update Salsa part 1 (#16340) Upgrade Rust toolchain to 1.85.0 (#16339) ...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
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 jsonto retrieve all the rules. Then, I parsed the explanation field to get these 3 consistent sections:Why is this bad?What it doesExampleHowever, during the initial processing, I noticed that the markdown headings are not that consistent. For instance:
Use insteadappears as a normal paragraph within theExamplesection, but in the filecrates/ruff_linter/src/rules/flake8_bandit/rules/django_extra.rsit is a level-2 headingExampleheadings and 65Examples. But all of them only have one example caseThis PR normalized these across all rules.
Test Plan
CI are passed.