Skip to content

Docs: tweak rules documentation #14180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Nov 8, 2024
Merged

Docs: tweak rules documentation #14180

merged 2 commits into from
Nov 8, 2024

Conversation

sbrugman
Copy link
Contributor

@sbrugman sbrugman commented Nov 7, 2024

Summary

Found these while experimenting with the categorisation:

  • Use canonical PEP URLs (https://peps.python.org/ instead of https://www.python.org/dev/)
  • Provide a title to PEP references:
    • If the URL links to the full PEP, then use PEP [code] - [page title]
    • If the URL links to a specific section, then use PEP [code]: [section title]
  • Add references to the Python documentation in a few places.
  • Ensure that titles to the Python documentation are consistent.
  • Fix links to Typing documentation (page was moved).
  • Various small extensions to examples.

@sbrugman sbrugman requested a review from AlexWaygood as a code owner November 7, 2024 23:19
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 7, 2024 •
edited
Loading

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

AlexWaygood
AlexWaygood reviewed Nov 7, 2024
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Overall this is great!

@AlexWaygood AlexWaygood added the documentation Improvements or additions to documentation label Nov 7, 2024
@sbrugman
Copy link
Contributor Author

sbrugman commented Nov 7, 2024

Thanks for the quick comments @AlexWaygood

AlexWaygood
AlexWaygood approved these changes Nov 8, 2024
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks great! Just two more nits:

@MichaReiser @AlexWaygood
Apply suggestions from code review
16cd152 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@MichaReiser MichaReiser enabled auto-merge (squash) November 8, 2024 08:57
@MichaReiser MichaReiser merged commit d1ef418 into astral-sh:main Nov 8, 2024
18 checks passed
@sbrugman sbrugman deleted the docs-rule-tweaks branch November 8, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sbrugman @AlexWaygood @MichaReiser