Use a StrEnum to record linkcheck status codes
#13043
Merged
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
jayaddison
commented
Oct 19, 2024
jayaddison
commented
Oct 19, 2024
AA-Turner
reviewed
Oct 19, 2024
sphinx/builders/linkcheck.py
Outdated
| @@ -158,14 +172,14 @@ def process_result(self, result: CheckResult) -> None: | |||
| red('broken ') + result.uri + red(' - ' + result.message) | |||
| ) | |||
| self.write_entry( | |||
| 'broken', | |||
| result.status, | |||
There was a problem hiding this comment.
Suggested change
| result.status, | |
| LinkStatus.BROKEN.value, |
There was a problem hiding this comment.
Using a specific symbol/status-code per write_entry call makes sense to me; I'm less sure about the .value access though. What's the thinking there?
There was a problem hiding this comment.
'broken' is a literal, the closest semantic replacement is the LinkStatus.BROKEN.value constant, rather than the result.status variable.
AA-Turner
reviewed
Oct 20, 2024
AA-Turner
changed the title
StrEnum for status codesStrEnum to record status codes
AA-Turner
changed the title
StrEnum to record status codesStrEnum to record status codes
jayaddison
commented
Oct 20, 2024
AA-Turner
approved these changes
Oct 20, 2024
AA-Turner
changed the title
StrEnum to record status codesStrEnum to record linkcheck status codes
|
Thanks @AA-Turner! |
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.
Feature or Bugfix
Purpose
linkcheckbuilder.Detail
StrEnumto declare the available hyperlink result status codes.Relates
Literal#13040.