Contributor guide: document sources of autogenerated reference docs#490
Merged
sharkdp merged 1 commit intoastral-sh:mainfrom May 23, 2025
Merged
Conversation
Explain that some ty help text and reference documentation result from source code that lives in Ruff, and point to sources, to help tech writer contributors.
fc8d8da to
730a68f
Compare
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
3 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
Explain in
CONTRIBUTING.mdthat some ty help text and reference documentation result from source code that lives in Ruff, and point to sources, to help tech writer contributors.Inspired by my stumble in #478 and subsequent pointers in astral-sh/ruff#18246 .
Test Plan
I used
git grepto search the Ruff repository for several chunks of the prose indocs/reference/to verify which source code contains text that turns into the autogenerated docs. I pushed my branch to GitHub and manually checked that the formatting and hyperlinks were correct.