docs: Correct collections-named-tuple example to use PascalCase assignment #16884
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
The documentation for
collections-named-tuple
(PYI024
) was using a lowercase variable in its example:while the recommended replacement used
class Person
– implying a name change that's not equivalent. This patch updates the docstring to use a more canonical example:so that the “Use instead:” block aligns with the original name and doesn't suggest a breaking rename. No functional code changes were required.
Test Plan
Only documentation comments were updated; the existing
flake8_pyi
tests still pass (cargo test -p ruff_linter
). Running the full workspace tests yields a failure in an unrelated snapshot when run as root, but in a typical developer environment the existing tests and snapshots remain unaffected. All style and lint checks pass (cargo clippy
,cargo fmt
, etc.).This PR was generated by an AI system in collaboration with maintainers: @carljm, @ntBre
Fixes #16492