fix: ignore cross reference conversion in examples #332
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
dansaadati
approved these changes
Nov 1, 2023
| # If the reference is found after example section, ignore it. | ||
| if uid and ( | ||
| not ignore_examples or | ||
| (ignore_examples and index < example_index) |
There was a problem hiding this comment.
LGTM, as long as there cannot be content after the example.
There was a problem hiding this comment.
Examples: is only used by the bigframes team and it's their last content in the summary.
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.
Bigframes team saw that cross references were converting their example code content, see https://cloud.google.com/python/docs/reference/bigframes/latest/bigframes.session.Session#bigframes_session_Session_read_gbq. The conversion for cross references don't work in code content, temporarily fixing this for Bigframes team's example.
I've filed #331 to follow up to ensure that code content gets properly converted into links. Until then, for example content found in the summary, they won't get converted into xrefs.
Fixes b/306420925.