std domain: parse conjoined option placeholders#14415
Open
lawrence3699 wants to merge 2 commits intosphinx-doc:masterfrom
Open
std domain: parse conjoined option placeholders#14415lawrence3699 wants to merge 2 commits intosphinx-doc:masterfrom
lawrence3699 wants to merge 2 commits intosphinx-doc:masterfrom
Conversation
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
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.
Purpose
Fix std-domain option parsing for conjoined angle-bracket placeholders such as
-S<value>.Previously, the parser treated the whole string as the option name, so the directive registered
-S<value>instead of-S. This keeps the placeholder in the argument portion, and extends:option:resolution so references like-S<other>resolve through the registered option stem.Validation:
.venv/bin/python -m pytest tests/test_domains/test_domain_std.py -q.venv/bin/python -m pytest tests/test_directives/test_directive_option.py tests/test_domains/test_domain_std.py -q.venv/bin/ruff check sphinx/domains/std/__init__.py tests/test_domains/test_domain_std.py.venv/bin/ruff format --check sphinx/domains/std/__init__.py tests/test_domains/test_domain_std.pyReferences