Open
Conversation
Contributor
Author
|
TODO:
@vincentmacri FYI |
|
Documentation preview for this PR (built with commit b030c05; changes) is ready! 🎉 |
5 tasks
vincentmacri
suggested changes
Feb 17, 2026
Member
vincentmacri
left a comment
There was a problem hiding this comment.
This needs more documentation/comments before I can review this as I'm not familiar with the Cython libraries in use here (and presumably most other Sage contributors aren't familiar with it either).
Please add:
- A module docstring giving a high-level overview of that this code does and how it works (include links to the documentation of the relevant Cython libraries being used)
- Function docstrings (I don't think we need doctests, just descriptions of each function)
Do you intend to run this script in this PR and add the autogenerated typestubs as well? Any plans to upstream this to Cython?
| @@ -0,0 +1,625 @@ | |||
| #!/usr/bin/env python3 | |||
Member
There was a problem hiding this comment.
Your PR description says this file was taken/adapted from somewhere else? Then it needs to include the relevant copyright info.
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
For automatically generating/checking type stubs for Cython modules. Based on/inspired by https://github.com/Vizonex/CyStub/ (but extended to handle default values, check mode etc)
Pretty basic at the moment, main functionality is to check that the existing stubs contain exactly the methods that we expect them to have.
📝 Checklist
⌛ Dependencies