Ensure linkcheck items are comparable#8579
Merged
tk0miya merged 1 commit intosphinx-doc:3.4.xfrom Dec 23, 2020
Merged
Conversation
6b80659 to
a9a83f0
Compare
Linkcheck organizes the URLs to checks in a PriorityQueue. The items are tuples (priority, url, docname, lineno). Tuples where the lineno is `None` are not comparable with tuples that have an integer lineno, and PriorityQueue items must be comparable (see https://bugs.python.org/issue31145). Fixes an issue when a document contains two links to the same URL, one with an int line number and the other without line number metadata (such as an image :target: attribute). Using 0 instead of None to represent no line number should not lead to observable changes, the result logger only logs the line number when it is truthy. Close sphinx-doc#8565
a9a83f0 to
a1b8b1f
Compare
Member
|
Thank you for your quick work! |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 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.
Feature or Bugfix
Purpose
Fixes an issue when a document contains two links to the same URL, one with
an int line number and the other without line number metadata (such as an
image :target: attribute).
Details
Linkcheck organizes the URLs to checks in a PriorityQueue. The items are
tuples (priority, url, docname, lineno).
Tuples where the lineno is
Noneare not comparable with tuples that havean integer lineno, and PriorityQueue items must be comparable (see
https://bugs.python.org/issue31145).
Using 0 instead of None to represent no line number should not lead to
observable changes, the result logger only logs the line number when it is
truthy.
Relates
Close #8565