Skip to content
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

Fix category of ModularFormsRing and documentation cleanup #37821

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from

Conversation

DavidAyotte
Copy link
Member

The goal of this PR is twofold:

First, we fix the category of modular forms ring as per PR #37797 to make the following code work:

sage: M = ModularFormsRing(1)
sage: M['z', 'w']
Multivariate Polynomial Ring in z, w over Ring of Modular Forms for Modular Group SL(2,Z) over Rational Field

Second, we do a documentation and PEP8 cleanup of the class ModularFormsRing.

CC: @fchapoton

πŸ“ Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

βŒ› Dependencies

Copy link

github-actions bot commented Apr 17, 2024

Documentation preview for this PR (built with commit 9435547; changes) is ready! πŸŽ‰
This preview will update shortly after each push to this PR.

separated string
- ``gens`` (default: None) -- (list) a list of generator of
``self``. If ``gens`` is ``None`` then the generators returned by
:meth:`~sage.modular.modform.find_generator.ModularFormsRing.gen_forms`
is used instead.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same comment as above. In this case, we may remove (list).

@@ -976,7 +1001,7 @@ def _find_generators(self, maxweight, start_gens, start_weight):
@cached_method
def q_expansion_basis(self, weight, prec=None, use_random=True):
r"""
Calculate a basis of q-expansions for the space of modular forms of the
Return a basis of q-expansions for the space of modular forms of the
given weight for this group, calculated using the ring generators given
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

`q`

@kwankyu
Copy link
Collaborator

kwankyu commented May 31, 2024

Otherwise lgtm.

Please rebase to develop.

@DavidAyotte
Copy link
Member Author

DavidAyotte commented Jun 1, 2024

Thank you for the review! Tell me if there is anything else to add/modify.

@kwankyu
Copy link
Collaborator

kwankyu commented Jun 1, 2024

... Tell me if there is anything else to add/modify.

This was good enough. But since you ask, I suggested more :-)

@DavidAyotte
Copy link
Member Author

Done ! Thank you !

Copy link
Collaborator

@kwankyu kwankyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. LGTM.

@vbraun
Copy link
Member

vbraun commented Jun 3, 2024

merge conflict

vbraun pushed a commit to vbraun/sage that referenced this pull request Jun 4, 2024
    
<!-- ^ 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". -->

which I think are already established.  But it is good to recommend
preferred styles to keep docstrings in consistent styles.

motivated by the comment:
sagemath#37821 (comment)

### πŸ“ Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### βŒ› Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->

sagemath#38068 (merged here)
    
URL: sagemath#38117
Reported by: Kwankyu Lee
Reviewer(s): gmou3, Kwankyu Lee
vbraun pushed a commit to vbraun/sage that referenced this pull request Jun 5, 2024
    
<!-- ^ 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". -->

which I think are already established.  But it is good to recommend
preferred styles to keep docstrings in consistent styles.

motivated by the comment:
sagemath#37821 (comment)

### πŸ“ Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### βŒ› Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->

sagemath#38068 (merged here)
    
URL: sagemath#38117
Reported by: Kwankyu Lee
Reviewer(s): gmou3, Kwankyu Lee
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants