DM-36116: Add docs for ellipsis workaround. #138
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
Codecov Report
@@ Coverage Diff @@
## main #138 +/- ##
==========================================
+ Coverage 92.12% 92.13% +0.01%
==========================================
Files 44 44
Lines 2729 2733 +4
==========================================
+ Hits 2514 2518 +4
Misses 215 215
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
timj
approved these changes
Sep 6, 2022
There was a problem hiding this comment.
These changes look good but now I realize that types.EllipsisType does exist in python 3.10 -- shouldn't we be using it here if it is defined and only falling back to the existing code if it's an older python?
https://docs.python.org/3/library/types.html#types.EllipsisType and https://docs.python.org/3/library/constants.html#Ellipsis
python/lsst/utils/ellipsis.py
Outdated
| behave as expected under ``is`` comparisons and type-narrowing expressions, | ||
| such as:: | ||
|
|
||
| v: EllipseType | int |
python/lsst/utils/ellipsis.py
Outdated
| such as:: | ||
|
|
||
| v: EllipseType | int | ||
| if v is not Ellipse: |
This replaces an outdated code comment with a module docstring, since it doesn't look possible to actually document the symbols exported by this module.
TallJimbo
force-pushed
the
tickets/DM-36116
branch
from
a286a51
to
78aade4
Compare
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 replaces an outdated code comment with a module docstring, since it doesn't look possible to actually document the symbols exported by this module.
Checklist
added a release note for user-visible changes to: I don't think it's user-visibly distinct from DM-36108.doc/changes