add some typing annotations to gens methods (-> tuple) #39233
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
tobiasdiez
reviewed
Dec 31, 2024
|
Documentation preview for this PR (built with commit e336e04; changes) is ready! 🎉 |
tobiasdiez
reviewed
Jan 1, 2025
| @@ -3919,10 +3918,12 @@ def __hash__(self): | |||
| return 0 | |||
|
|
|||
| @cached_method | |||
| def gens(self): | |||
| def gens(self): # -> PolynomialSequence | |||
There was a problem hiding this comment.
At least here its relatively clear that it's returning PolynomialSequence_generic or not?
There was a problem hiding this comment.
I have used Sequence_generic here
| @@ -622,7 +622,7 @@ def reduce(self, f): | |||
| """ | |||
| return f # default | |||
|
|
|||
| def gens(self): | |||
| def gens(self): # -> tuple | PolynomialSequence | |||
There was a problem hiding this comment.
and I did not make any serious analysis of the possible types that can appear here
There was a problem hiding this comment.
This could use from sage.structure.sequence import Sequence_generic maybe. But I would rather keep it as it is now.
tobiasdiez
approved these changes
Jan 3, 2025
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jan 5, 2025
adding some annotations in`rings` folder
to help find the cases where `gens` and related methods do not return a
tuple (mostly for ideals now)
### 📝 Checklist
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
URL: sagemath#39233
Reported by: Frédéric Chapoton
Reviewer(s): Frédéric Chapoton, Tobias Diez
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.
adding some annotations in
ringsfolderto help find the cases where
gensand related methods do not return a tuple (mostly for ideals now)📝 Checklist