Improve documentation in diamond_cutting.py #39844
Open
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
b3ac571 to
6897766
Compare
|
Documentation preview for this PR (built with commit 69e9011; changes) is ready! 🎉 |
tscrim
approved these changes
Apr 2, 2025
|
You're right. A look at the sagemath codebase shows that ALGORITHM is usually before EXAMPLES. I'll make the change. |
|
Once done, you can reset the positive review. |
|
Thanks! I made the change and reset to positive review. |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Apr 7, 2025
sagemathgh-39844: Improve documentation in diamond_cutting.py The docstring of the `diamond_cutting` method of a lattice (in `src/sage/modules/diamond_cutting.py`) states that the parameter `C` is the radius that will be used in the cutting algorithm, but `C` is actually the *square* of the radius. (This problem was mentioned in a comment on sagemath#37086.) We correct this misstatement and also provide some other minor improvements to the documentation of this method and the `jacobi` method in the same file. This includes adding a relevant reference. ### 📝 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: ... --> URL: sagemath#39844 Reported by: DaveWitteMorris Reviewer(s): Travis Scrimshaw
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Apr 10, 2025
sagemathgh-39844: Improve documentation in diamond_cutting.py The docstring of the `diamond_cutting` method of a lattice (in `src/sage/modules/diamond_cutting.py`) states that the parameter `C` is the radius that will be used in the cutting algorithm, but `C` is actually the *square* of the radius. (This problem was mentioned in a comment on sagemath#37086.) We correct this misstatement and also provide some other minor improvements to the documentation of this method and the `jacobi` method in the same file. This includes adding a relevant reference. ### 📝 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: ... --> URL: sagemath#39844 Reported by: DaveWitteMorris Reviewer(s): Travis Scrimshaw
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 docstring of the
diamond_cuttingmethod of a lattice (insrc/sage/modules/diamond_cutting.py) states that the parameterCis the radius that will be used in the cutting algorithm, butCis actually the square of the radius. (This problem was mentioned in a comment on #37086.) We correct this misstatement and also provide some other minor improvements to the documentation of this method and thejacobimethod in the same file. This includes adding a relevant reference.📝 Checklist
⌛ Dependencies