Docs: Link inline settings when not part of options section #10499
Conversation
This file contains 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
augustelalande
force-pushed
the
link-inline-settings
branch
from
a91963b
to
352fada
Compare
|
charliermarsh
added
bug
MichaReiser
reviewed
Mar 21, 2024
crates/ruff_dev/src/generate_docs.rs
Outdated
| let re = Regex::new(r"\[`([^`]*?)`]\[(.*?)]").unwrap(); | ||
| for (_, [option, _]) in re.captures_iter(&documentation).map(|c| c.extract()) { | ||
| if let Some(OptionEntry::Field(field)) = Options::metadata().find(option) { | ||
| if !options.contains(option) { |
There was a problem hiding this comment.
Nit: I first assumed that options points to Options::metadata, which isn't the case. What I understand is that options stores all linked or referenced options, maybe rename to linked_options or referenced_options?
There was a problem hiding this comment.
I renamed to referenced_options.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Some contributors have referenced settings in their documentation without adding the settings to an options section, this has lead to some rendering issues (#10427). This PR addresses this looking for potential inline links to settings, cross-checking them with the options sections, and then linking them anyway if they are not found.
Resolves #10427.
Test Plan
Manually verified that the correct modifications were made and no docs were broken.