-
-
Notifications
You must be signed in to change notification settings - Fork 405
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
sage.modular
: Docstring/doctest cosmetics
#37714
sage.modular
: Docstring/doctest cosmetics
#37714
Conversation
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 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
self
argument 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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\dag
is 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! 🎉 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, LGTM.
Thanks! |
<!-- ^ 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
Cherry-picked from #35095.
📝 Checklist
⌛ Dependencies