sage.modular: Docstring/doctest cosmetics
#37714
Merged
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
S17A05
reviewed
Apr 5, 2024
Comment on lines
478
to
495
| Return the character of self. For overconvergent forms, the weight and | ||
| Return the character of ``self``. For overconvergent forms, the weight and | ||
| the character are unified into the concept of a weight-character, so | ||
| this returns exactly the same thing as self.character(). | ||
| this returns exactly the same thing as ``self.character()``. |
There was a problem hiding this comment.
- This should probably say "Return the weight ..." instead of "Return the character ..."
- It might be good to separate the second sentence by a blank line here, or transform the second sentence into a
.. NOTE - Since the documentation does not show the
selfargument as we see it in the code, it would be better to avoid referring to it in the docstrings (this applies to multiple docstrings of the changed files). For example, here one could instead write:
"Return the weight of this space of overconvergent modular forms. For overconvergent forms, the weight and the character are unified into the concept of a weight-character, so this returns exactly the same thing as thecharacter()-method."
There was a problem hiding this comment.
I've made some of the suggested changes (and others) in 00c0c70.
Referring to self in method docstrings is done throughout the Sage documentation; I'm not changing this here.
Co-authored-by: Sebastian A. Spindler <153911337+S17A05@users.noreply.github.com>
S17A05
reviewed
Apr 6, 2024
There was a problem hiding this comment.
The changes look good to me; there are two more small things I noticed in genus0.py:
S_k^\dag(1, r)in line 42 does not render properly in the documentation; I'm not sure what\dagis supposed to be here, though.- Similar to the changes you made in the other methods, the docstrings of
.hecke_matrix()and.recurrence_matrix()should be rewritten a bit.
|
Thanks, done. I've done a larger change in |
|
Documentation preview for this PR (built with commit 3ee561a; changes) is ready! 🎉 |
|
Thanks! |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Apr 20, 2024
sagemathgh-37714: `sage.modular`: Docstring/doctest cosmetics <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> Cherry-picked from sagemath#35095. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#37714 Reported by: Matthias Köppe Reviewer(s): Matthias Köppe, Sebastian A. Spindler
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.
Cherry-picked from #35095.
📝 Checklist
⌛ Dependencies