docs: fix ambiguous builtin cross-references - #3672
Merged
Merged
Conversation
Autodoc emits type annotations as "specific" cross-references, so a target with no exact match is looked up by suffix. Classes with fields named after builtin types (`int` in `utils.model_ekg`, `bytes` and `type` in `utils.dbsync_queries`) match plain annotations like `int`, which produced 1108 "more than one target found" warnings and linked the annotations to unrelated attributes. Drop the `refspecific` flag from cross-references to builtin types. The python domain tests for the presence of the flag, not for its value, so the attribute has to be removed.
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
1 participant
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.
Autodoc emits type annotations as "specific" cross-references, so a target with no exact match is looked up by suffix. Classes with fields named after builtin types (
intinutils.model_ekg,bytesandtypeinutils.dbsync_queries) match plain annotations likeint, which produced 1108 "more than one target found" warnings and linked the annotations to unrelated attributes.Drop the
refspecificflag from cross-references to builtin types. The python domain tests for the presence of the flag, not for its value, so the attribute has to be removed.