sphinxdocs: make Any and object types no-ops to avoid missing xrefs#2905
Merged
rickeylev merged 2 commits intobazel-contrib:mainfrom May 18, 2025
Merged
Conversation
…into sphinxdocs.special.case.any.object
aignas
approved these changes
May 18, 2025
dougthor42
reviewed
May 18, 2025
|
|
||
| # Any and object are just conventions from Python, but useful for | ||
| # indicating what something is in Starlark, so treat them specially. | ||
| if node["reftarget"] in ("Any", "object"): |
Collaborator
There was a problem hiding this comment.
node["reftarget"].lower() in ("any", "object"):? I'm not sure if any is different from Any.
Collaborator
Author
There was a problem hiding this comment.
In python land, it's case sensitive. This is all informal, so we can kind of make it up. And for doc purposes, either might be convenient. For now, I'm just gonna match Python.
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.
The "Any" and "object" types are useful in expression starlark types, but aren't actually
real things. Treat them like None and make them no-ops so they aren't treated like
missing xrefs.