Fix category of ModularFormsRing and documentation cleanup #37821
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
|
Documentation preview for this PR (built with commit 9435547; changes) is ready! 🎉 |
kwankyu
reviewed
May 31, 2024
kwankyu
reviewed
May 31, 2024
kwankyu
reviewed
May 31, 2024
kwankyu
reviewed
May 31, 2024
|
Otherwise lgtm. Please rebase to develop. |
5 tasks
|
Thank you for the review! Tell me if there is anything else to add/modify. |
kwankyu
reviewed
Jun 1, 2024
kwankyu
reviewed
Jun 1, 2024
kwankyu
reviewed
Jun 1, 2024
This was good enough. But since you ask, I suggested more :-) |
|
|
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
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jun 8, 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
kwankyu
reviewed
Aug 29, 2024
kwankyu
reviewed
Aug 29, 2024
kwankyu
reviewed
Aug 29, 2024
kwankyu
reviewed
Aug 29, 2024
|
It looks like the documentation does not build: Do you know what might cause this? |
|
This #38468 will fix the doc build ci. You may merge that to this PR if you want to see the built doc. |
|
Ok thanks, since it is not related with this PR, I'm setting it back to |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 5, 2024
…cleanup
<!-- ^ 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". -->
The goal of this PR is twofold:
First, we fix the category of modular forms ring as per PR sagemath#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
<!-- 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.
- [x] I have linked a relevant issue or discussion.
- [x] 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: ... -->
URL: sagemath#37821
Reported by: David Ayotte
Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 6, 2024
…cleanup
<!-- ^ 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". -->
The goal of this PR is twofold:
First, we fix the category of modular forms ring as per PR sagemath#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
<!-- 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.
- [x] I have linked a relevant issue or discussion.
- [x] 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: ... -->
URL: sagemath#37821
Reported by: David Ayotte
Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 8, 2024
…cleanup
<!-- ^ 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". -->
The goal of this PR is twofold:
First, we fix the category of modular forms ring as per PR sagemath#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
<!-- 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.
- [x] I have linked a relevant issue or discussion.
- [x] 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: ... -->
URL: sagemath#37821
Reported by: David Ayotte
Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 8, 2024
…cleanup
<!-- ^ 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". -->
The goal of this PR is twofold:
First, we fix the category of modular forms ring as per PR sagemath#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
<!-- 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.
- [x] I have linked a relevant issue or discussion.
- [x] 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: ... -->
URL: sagemath#37821
Reported by: David Ayotte
Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 10, 2024
…cleanup
<!-- ^ 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". -->
The goal of this PR is twofold:
First, we fix the category of modular forms ring as per PR sagemath#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
<!-- 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.
- [x] I have linked a relevant issue or discussion.
- [x] 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: ... -->
URL: sagemath#37821
Reported by: David Ayotte
Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 12, 2024
…cleanup
<!-- ^ 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". -->
The goal of this PR is twofold:
First, we fix the category of modular forms ring as per PR sagemath#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
<!-- 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.
- [x] I have linked a relevant issue or discussion.
- [x] 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: ... -->
URL: sagemath#37821
Reported by: David Ayotte
Reviewer(s): Kwankyu Lee
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.
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:
Second, we do a documentation and PEP8 cleanup of the class
ModularFormsRing.CC: @fchapoton
📝 Checklist
⌛ Dependencies