[proof of concept] Fix anchor links for inlined classes #2215
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
This was referenced Oct 31, 2024
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 1, 2024
Closes #2210. Before, cross references to inlined class methods would try using the link `InlineClass.some_method`, but the link should really be `some_method` without `InlineClass`. The better fix is #2215 because it avoids the risk of ambiguous anchors. However, it would be a UX regression to land that until #1395 is done. Fixing this is tracked by #2217.
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.
Closes #2210. Before, we would convert anchor links like
runtime-job#qiskit_ibm_runtime.RuntimeJob.submitto beruntime-job#submit. This is because the header is set tosubmit, so that is the autogenerated anchor for the header.We could instead link to the original full ID like
#qiskit_ibm_runtime.RuntimeJob.submitbecause we set this on the component itself, like the<Functioncomponent. However, until we solve #1395, that means the anchor will take you below the header to the colored bar. That is especially problematic for attributes which don't have a code signature, like the second image.So, this PR is the best solution long-term, but blocked by #1395.