docstrings: Change single dash to double dash after input variables #38069
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
fixing the linter warning
…into drinfeld_modform
sagemathgh-38059: `sage.ext.fast_callable`: Docstring 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 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#38059 Reported by: Matthias Köppe Reviewer(s): gmou3, Kwankyu Lee, Matthias Köppe
sagemathgh-38060: `sage.rings`: Modularization fixes for singular <!-- ^ 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". --> Removing the use of a Singular interpreter instance as a default value of parameters - Cherry-picked from sagemath#35095. ### 📝 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. - [ ] I have created tests covering the changes. - [ ] 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#38060 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee, Matthias Köppe
sagemathgh-38061: `sage.rings`: Modularization fixes (imports) <!-- ^ 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". --> Replacing unconditional imports from `sage.libs.pari`, `sage.misc.sage_eval`, `sage.rings.number_field`, `sage.rings.polynomial.pbori`, `sage.symbolic` using standard modularization techniques. - 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 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#38061 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
sagemathgh-38065: `sage.graphs`: 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 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#38065 Reported by: Matthias Köppe Reviewer(s): gmou3
sagemathgh-38066: `sage.geometry`: Modularization fixes (imports), `# needs` <!-- ^ 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 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#38066 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
sagemathgh-38067: `.ci/write-dockerfile.sh`: Quoting fix for `unminimize` <!-- ^ 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". --> On docker-ubuntu, we attempted to remove the `unminimize` program after running it once, but this has failed because of quoting mistake. https: //github.com/mkoeppe/sage/actions/runs/9219405769/job/25364502464#step:9 :311 Fixed here. ### 📝 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. - [ ] 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#38067 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee, Matthias Köppe
sagemathgh-38071: `sage.categories`: Update `# needs`, use block tags <!-- ^ 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 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#38071 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
sagemathgh-38074: `sage.combinat`: Modularization fixes (imports), update `# needs` <!-- ^ 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 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#38074 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
sagemathgh-38078: remove inheritance from Algebra in FreeAlgebras as another move towards removal of the "Algebra" class, using "Parent" framework instead. ### 📝 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. - [x] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. URL: sagemath#38078 Reported by: Frédéric Chapoton Reviewer(s): Matthias Köppe
sagemathgh-38079: fix pep8 E302 in algebras and categories (scripted) This fixes all warnings for pep8 E302 in `algebras` and `categories` folders : ``` E302 expected 2 blank lines, found 0 or 1. ``` This was purely scripted using `autopep8`. ### 📝 Checklist - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. URL: sagemath#38079 Reported by: Frédéric Chapoton Reviewer(s): Matthias Köppe
sagemathgh-38080: fixing superfluous empty lines in libs folder this is removing empty lines in the `libs` folder in `.pyx` files, for compliance with pep8 E302 and E305 ### 📝 Checklist - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. URL: sagemath#38080 Reported by: Frédéric Chapoton Reviewer(s): Matthias Köppe
sagemathgh-38081: Fix sage.symbolic feature after libs/pynac removal Fixes sagemath#37873 (comment) URL: sagemath#38081 Reported by: Antonio Rojas Reviewer(s):
sagemathgh-38082: CI fix: broken livedoc <!-- ^ 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". --> as seen in https://github.com/sagemath/sage/actions/runs/9234699215/job/25408704331 #:~:text=bash%3A%20line%201%3A%20cd%3A%20./worktree%2Dimage%3A%20No%20su ch%20file%20or%20directory ### 📝 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. - [ ] I have created tests covering the changes. - [ ] 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#38082 Reported by: Kwankyu Lee Reviewer(s):
sagemathgh-38087: Still add rpath to our own libstdc++, in case we built our own toolchain The GMP configure test should link against our own libstdc++ instead of the (too old) system libstdc++ Fixes sagemath#38085 URL: sagemath#38087 Reported by: Volker Braun Reviewer(s):
sagemathgh-38091: Fix doctest when the optional benzene is installed ``` ********************************************************************** File "src/sage/features/__init__.py", line 384, in sage.features.Feature.hide Failed example: len(list(graphs.fusenes(2))) # optional - benzene, needs sage.graphs Expected nothing Got: 1 ********************************************************************** 1 item had failures: 1 of 6 in sage.features.Feature.hide [146 tests, 1 failure, 3.74 s] ********************************************************************** ``` Comes from 1ade282 URL: sagemath#38091 Reported by: Volker Braun Reviewer(s):
### 📝 Checklist - [x] The title is concise and informative. - [x] I have updated the documentation and checked the documentation preview. URL: sagemath#38092 Reported by: gmou3 Reviewer(s): Matthias Köppe
Using the following regex: Find: ( [ ]*- [^ *()\[\]^]* )-( ) Replace: $1--$2
Search for similar patterns with double spaces, e.g.: " - something - "
a0fcd09 to
038f6f1
Compare
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
May 29, 2024
sagemathgh-38069: docstrings: Change single dash to double dash after input variables This is achieved by using variants of the following regex rule: ``` Find: ([ ]*- [^ *()\[\]^]* )-( ) Replace: $1--$2 ``` **For the reviewer**: to view the _diff_ succinctly run `git diff 10.4.beta7 -U0 | grep '^[+-]' | grep -Ev '^(--- a/|\+\+\+ b/)'` or see the attached file: [diff.txt](https://github.com/sagemath/sage/files/15447061/diff.txt) (computed from 307cbf9). Similar command with colors: `git diff --color 10.4.beta7 -U0 | grep -Ev 'diff|index|@@|---|\+\+\+'` URL: sagemath#38069 Reported by: gmou3 Reviewer(s): gmou3, 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.
This is achieved by using variants of the following regex rule:
For the reviewer: to view the diff succinctly run
git diff 10.4.beta7 -U0 | grep '^[+-]' | grep -Ev '^(--- a/|\+\+\+ b/)'or see the attached file: diff.txt (computed from 307cbf9).
Similar command with colors:
git diff --color 10.4.beta7 -U0 | grep -Ev 'diff|index|@@|---|\+\+\+'