Link checker: use the non-greedy quantifier to parse anchors #1104
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
|
Thanks for contributing to Qiskit documentation! Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌 |
frankharkins
approved these changes
Mar 27, 2024
|
Thank you both for the review! I added an mdx component to the test we already had 👍 |
Eric-Arellano
approved these changes
Mar 27, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
…1104) This small PR changes the regex used in the link checker to parse the anchors for a non-greedy version of it. After regenerating the API docs with the mdx components, our link checker wasn't able to detect the id from them that we previously had as `<span>` tags. The problem was how the script was searching for the ids. In the the following screenshots, we can see the change introduced here. **Before**  **After**  More information on the non-greedy quantifier here: https://www.ibm.com/docs/en/netcoolomnibus/8.1?topic=library-minimal-non-greedy-quantifiers To see that it fixed the issue, this change was applied to #Qiskit#1094, Qiskit#1101, and Qiskit#1102
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.
This small PR changes the regex used in the link checker to parse the anchors for a non-greedy version of it. After regenerating the API docs with the mdx components, our link checker wasn't able to detect the id from them that we previously had as
<span>tags.The problem was how the script was searching for the ids. In the the following screenshots, we can see the change introduced here.
Before
After
More information on the non-greedy quantifier here: https://www.ibm.com/docs/en/netcoolomnibus/8.1?topic=library-minimal-non-greedy-quantifiers
To see that it fixed the issue, this change was applied to ##1094, #1101, and #1102