[MNT] [TYPING]: Update MarkerType (#30257) #30261
Open
+10
−1
Conversation
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
timhoffm
reviewed
Jul 4, 2025
| MarkerType: TypeAlias = str | path.Path | MarkerStyle | ||
| MarkerType: TypeAlias = ( | ||
| path.Path | MarkerStyle | str | # str required for "$...$" marker | ||
| Literal[ |
There was a problem hiding this comment.
Since we have to keep str anyway, what is the advantage of spelling out the literal string values?
we can’t detect invalid values and completion also is not a relevant benefit if the values are almost all single characters.
There was a problem hiding this comment.
I agree that we don't really get completion, but we don't lose the suggestion when the string is opened.
That said, if you prefer, I can remove this and only keep the integers.
There was a problem hiding this comment.
Sorry for the silence.
Just wanted to check: would you prefer that I remove the string literals? I'll adjust the code accordingly.
This was referenced Jul 12, 2025
timhoffm
reviewed
Jul 14, 2025
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
timhoffm
approved these changes
Jul 14, 2025
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.
PR summary
This PR update the
MarkerTypeLiteralfor acceptedstrandintvalueslistfor acceptvertstuplefor accept regular polygon, star-like and asteriskPR checklist