docstrings: INPUT formatting #38145
Merged
docstrings: INPUT formatting #38145
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
…type_declarations
Especially for internal functions. This part (1/2) includes algorithmically neutral or positive changes.
This part contains some algorithmically questionable changes in `matroid.pyx`. Needs careful review.
Make the thing compile and pass the tests.
…gebraElement|FieldElement|EuclideanDomainElement|PrincipalIdealDomainElement|DedekindDomainElement|IntegralDomainElement|Matrix|Vector|ModuleElement|MonoidElement|AdditiveGroupElement|MultiplicativeGroupElement|RingElement|CommutativeRingElement';SUFFIX=" ; do eval "$a"; git --no-pager grep -l -E 'is_('$CLASS')' | xargs sed -E -i.bak 's/import is_('$CLASS')/import \1'$SUFFIX'/;/^ +/s/is_('$CLASS')[(]([^()]*([(][^()]*[)])?[^()]*)[)]/isinstance(\2, \1'$SUFFIX')/g'; done
added 13 commits
June 4, 2024 23:29
…Field`, `is_RelativeNumberField`, `is_NumberFieldIdeal`, `is_NumberFieldFractionalIdeal`, `is_NumberFieldFractionalIdeal_rel`
<!-- ^ 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". -->
### 📝 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.
- [ ] 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#38124
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee, Matthias Köppe
<!-- ^ 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". --> ### 📝 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. - [ ] 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#38125 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee
…lection`, `is_ToricLattice`, `is_ToricLatticeElement`, `is_ToricLatticeQuotient`
<!-- ^ 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". -->
### 📝 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.
- [ ] 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#38126
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee
<!-- ^ 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". --> solves some items of wishlist in sagemath#37759 ### 📝 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#38127 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
simplify code in various places by using more list comprehension, as
suggested by `ruff --select=PERF4`
### 📝 Checklist
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
URL: sagemath#38131
Reported by: Frédéric Chapoton
Reviewer(s): Matthias Köppe
…numerical/
fixing pycodestyle warning for blank lines in pyx files in `groups` and
`numerical` folders
### 📝 Checklist
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
URL: sagemath#38132
Reported by: Frédéric Chapoton
Reviewer(s): Matthias Köppe
fixing pycodestyle warning about blank lines in pyx files in `coding`
and `modules`
### 📝 Checklist
- [ ] The title is concise and informative.
- [ ] The description explains in detail what this PR is about.
URL: sagemath#38133
Reported by: Frédéric Chapoton
Reviewer(s): Matthias Köppe
fixing pycodestyle warning for blank lines in pyx files in matrix folder
### 📝 Checklist
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
URL: sagemath#38134
Reported by: Frédéric Chapoton
Reviewer(s): Matthias Köppe
…SE, AVX
Fixes sagemath#38000
Upstream PR at linbox-team/fflas-ffpack#397
URL: sagemath#38136
Reported by: Volker Braun
Reviewer(s):
some care for blank lines in pyx files in `rings` (only partial here)
### 📝 Checklist
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
URL: sagemath#38137
Reported by: Frédéric Chapoton
Reviewer(s): Matthias Köppe
<!-- ^ 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#38143 Reported by: Matthias Köppe Reviewer(s): David Coudert
<!-- ^ 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". --> CI Fix to fix the doctest dataflow warning that shows in all PRs: sagemath#38143 (review) ### 📝 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#38146 Reported by: Matthias Köppe Reviewer(s): David Coudert
…t is picked
On Debian 12 32-bit I get:
```
**********************************************************************
File "src/sage/geometry/polyhedral_complex.py", line 935, in
sage.geometry.polyhedral_complex.PolyhedralComplex._an_element_
Failed example:
pc._an_element_().vertices_list()
Expected:
[[0, 0], [0, 1/2], [1, 2]]
Got:
[[0, 0], [1/3, 1/3], [1, 2]]
**********************************************************************
1 item had failures:
1 of 4 in
sage.geometry.polyhedral_complex.PolyhedralComplex._an_element_
[469 tests, 1 failure, 17.41 s]
----------------------------------------------------------------------
sage -t --long --random-seed=0 src/sage/geometry/polyhedral_complex.py
# 1 doctest failed
----------------------------------------------------------------------
```
Just accept either of the two maximal cells
URL: sagemath#38148
Reported by: Volker Braun
Reviewer(s): Matthias Köppe
kwankyu
reviewed
Jun 4, 2024
gmou3
force-pushed
the
docstrings_input_formatting
branch
from
ff7bab7
to
ad9633d
Compare
most of them scripted using `autopep8`, and a few ones by hand ; only in `py` files ### 📝 Checklist - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. URL: sagemath#38149 Reported by: Frédéric Chapoton Reviewer(s): David Coudert
93 tasks
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jul 31, 2024
Large scale formatting of the docstrings in accordance with the [Developer Guide](https://doc.sagemath.org/html/en/developer/coding_basics.html). The changes are done by applying `regex` rules followed by manual checks and edits. The commits will be kept in manageable sizes (of ~100 changed files). Similar preceding PR: sagemath#38145. ### Changes - `True`, `False`, `None`, `self` to ` ``True`` `, ` ``False`` `, ` ``None`` `, ` ``self`` ` - `- arg (type, default: val) -- description` to `- ``arg`` -- type (default: val); description` - First docstring sentences: enforce prescriptive form of initial verb and add missing full stops - Remove full stops from single-sentence `INPUT` argument descriptions - One-line `OUTPUT`s for short output descriptions - More math (`<math>` to `` `<math>` `` and ` ``<math>`` ` to `` `<math>` `` ) - Remove redundant whitespace ### Extra changes (not reflected in the Guide) - `non-negative`, `non-zero`, `non-positive` to `nonnegative`, `nonzero`, `nonpositive` - `"<string>"` to `'<string>'` ### Partial reviews by commit - [x] 01. 5219d62 (reviewer: @kwankyu) - [x] 02. 37fe9ec (reviewer: @davidlowryduda) - [x] 03. 1ed6ea5 (reviewer: @davidlowryduda) - [x] 04. a6b0382 (reviewer: @davidlowryduda) - [x] 05. c284b26 (reviewer: @davidlowryduda) - [x] 06. 021184a (reviewer: @davidlowryduda) - [x] 07. 713e80d (reviewer: @davidlowryduda) - [x] 08. 53ea68f (reviewer: @davidlowryduda) - [x] 09. 198e7ea (stash) - [x] 10. f8b7351 (merge) - [x] 11. 14a3682 (reviewer: @kwankyu) - [x] 12. 9eab12f (reviewer: @kwankyu) - [x] 13. 6c70e9e (reviewer: @kwankyu) - [x] 14. c9f4492 (reviewer: @kwankyu) - [x] 15. ad120b6 (merge) - [x] 16. 75b4801 (reviewer: @kwankyu) - [x] 17. 6922a4c (reviewer: @kwankyu) - [x] 18. 0716b41 (reviewer: @kwankyu) - [x] 19. 5f652ff (reviewer: @kwankyu) - [x] 20. f0445a3 (reviewer: @kwankyu) - [x] 21. 114c977 (reviewer: @kwankyu) - [x] 22. 068ba37 (reviewer: @davidlowryduda) - [x] 23. b0f1279 (reviewer: @kwankyu) - [x] 24. 03a7b01 (reviewer: @davidlowryduda) - [x] 25. db885d1 (reviewer: @kwankyu) - [x] 26. 33550bd (reviewer: @kwankyu) - [x] 27. d41de45 (reviewer: @kwankyu) - [x] 28. a2e9564 (reviewer: @kwankyu) - [x] 29. c0080c6 (reviewer: @kwankyu) - [x] 30. a049e61 (reviewer: @davidlowryduda) - [x] 31. 22e43fd (reviewer: @kwankyu) - [x] 32. 19b9da5 (reviewer: @kwankyu) - [x] 33. e2b4155 (reviewer: @kwankyu) - [x] 34. fa498ef (reviewer: @kwankyu) - [x] 35. 5adb22a (reviewer: @kwankyu) - [x] 36. 5410d08 (reviewer: @kwankyu) - [x] 37. d29c4ed (reviewer: @kwankyu) - [x] 38. babffff (reviewer: @kwankyu) - [x] 39. 16c9892 (reviewer: @kwankyu) - [x] 40. 055b9cf (reviewer: @kwankyu) - [x] 41. b6d2649 (reviewer: @kwankyu) - [x] 42. 9c9ec6d (reviewer: @kwankyu) - [x] 43. dc17b6c (reviewer: @kwankyu) - [x] 44. 629d9c2 (reviewer: @kwankyu) - [x] 45. 60fc897 (reviewer: @kwankyu) - [x] 46. 0b60f4f (reviewer: @kwankyu) - [x] 47. 1669486 (reviewer: @kwankyu) - [x] 48. aaf8cc8 (reviewer: @kwankyu) - [x] 49. d7d1ce3 (reviewer: @kwankyu) - [x] 50. e5b7753 (reviewer: @kwankyu) - [x] 51. 3e0473a (reviewer: @kwankyu) - [x] 52. ae07ccc (reviewer: @kwankyu) - [x] 53. 0995121 (merge) - [x] 54. 6b3aeff (reviewer: @kwankyu) - [x] 55. 6d8aa62 (reviewer: @kwankyu) - [x] 56. db6bec5 (reviewer: @kwankyu) - [x] 57. 75abe85 (reviewer: @kwankyu) - [x] 58. 7abd33c (reviewer: @kwankyu) - [x] 59. 07dd3f3 (reviewer: @kwankyu) - [x] 60. eb1f83b (reviewer: @kwankyu) - [x] 61. 61956fd (reviewer: @kwankyu) - [x] 62. 5696a97 (reviewer: @kwankyu) - [x] 63. b6ee3a2 (merge) - [x] 64. 53dad87 (reviewer: @kwankyu) - [x] 65. 032518d (reviewer: @kwankyu) - [x] 66. d97c1c7 (reviewer: @kwankyu) - [x] 67. f55ced3 (reviewer: @kwankyu) - [x] 68. 53aa5f0 (reviewer: @kwankyu) - [x] 69. be0d4dc (reviewer: @kwankyu) - [x] 70. 7ab69d4 (reviewer: @kwankyu) - [x] 71. 7754584 (reviewer: @kwankyu) - [x] 72. 6964c2f (reviewer: @kwankyu) - [x] 73. d176a3e (reviewer: @kwankyu) - [x] 74. 554d014 (reviewer: @kwankyu) - [x] 75. 6f1efc4 (reviewer: @kwankyu) - [x] 76. 4b8708e (reviewer: @kwankyu) - [x] 77. c8f546f (reviewer: @kwankyu) - [x] 78. d4a3ce9 (reviewer: @kwankyu) - [x] 79. 8f00496 (reviewer: @kwankyu) - [x] 80. 56f8390 (merge) - [x] 81. 41893fd (reviewer: @kwankyu) - [x] 82. d1c6631 (reviewer: @kwankyu) - [x] 83. 884363e (reviewer: @kwankyu) - [x] 84. 7162abb (reviewer: @kwankyu) - [x] 85. cbb9326 (merge) - [x] 86. 398226f (reviewer: @kwankyu) - [x] 87. 06c897c (merge) - [x] 88. 9456ded (merge) - [x] 89. 4d8caaa (merge) - [x] 90. 02e5da6 (merge) - [x] 91. beeb935 (lint) - [x] 92. f278392 (preemptive merge) - [x] 93. 588fddb (reviewer: @kwankyu) URL: sagemath#38155 Reported by: gmou3 Reviewer(s): David Lowry-Duda, Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Aug 2, 2024
Large scale formatting of the docstrings in accordance with the [Developer Guide](https://doc.sagemath.org/html/en/developer/coding_basics.html). The changes are done by applying `regex` rules followed by manual checks and edits. The commits will be kept in manageable sizes (of ~100 changed files). Similar preceding PR: sagemath#38145. ### Changes - `True`, `False`, `None`, `self` to ` ``True`` `, ` ``False`` `, ` ``None`` `, ` ``self`` ` - `- arg (type, default: val) -- description` to `- ``arg`` -- type (default: val); description` - First docstring sentences: enforce prescriptive form of initial verb and add missing full stops - Remove full stops from single-sentence `INPUT` argument descriptions - One-line `OUTPUT`s for short output descriptions - More math (`<math>` to `` `<math>` `` and ` ``<math>`` ` to `` `<math>` `` ) - Remove redundant whitespace ### Extra changes (not reflected in the Guide) - `non-negative`, `non-zero`, `non-positive` to `nonnegative`, `nonzero`, `nonpositive` - `"<string>"` to `'<string>'` ### Partial reviews by commit - [x] 01. 5219d62 (reviewer: @kwankyu) - [x] 02. 37fe9ec (reviewer: @davidlowryduda) - [x] 03. 1ed6ea5 (reviewer: @davidlowryduda) - [x] 04. a6b0382 (reviewer: @davidlowryduda) - [x] 05. c284b26 (reviewer: @davidlowryduda) - [x] 06. 021184a (reviewer: @davidlowryduda) - [x] 07. 713e80d (reviewer: @davidlowryduda) - [x] 08. 53ea68f (reviewer: @davidlowryduda) - [x] 09. 198e7ea (stash) - [x] 10. f8b7351 (merge) - [x] 11. 14a3682 (reviewer: @kwankyu) - [x] 12. 9eab12f (reviewer: @kwankyu) - [x] 13. 6c70e9e (reviewer: @kwankyu) - [x] 14. c9f4492 (reviewer: @kwankyu) - [x] 15. ad120b6 (merge) - [x] 16. 75b4801 (reviewer: @kwankyu) - [x] 17. 6922a4c (reviewer: @kwankyu) - [x] 18. 0716b41 (reviewer: @kwankyu) - [x] 19. 5f652ff (reviewer: @kwankyu) - [x] 20. f0445a3 (reviewer: @kwankyu) - [x] 21. 114c977 (reviewer: @kwankyu) - [x] 22. 068ba37 (reviewer: @davidlowryduda) - [x] 23. b0f1279 (reviewer: @kwankyu) - [x] 24. 03a7b01 (reviewer: @davidlowryduda) - [x] 25. db885d1 (reviewer: @kwankyu) - [x] 26. 33550bd (reviewer: @kwankyu) - [x] 27. d41de45 (reviewer: @kwankyu) - [x] 28. a2e9564 (reviewer: @kwankyu) - [x] 29. c0080c6 (reviewer: @kwankyu) - [x] 30. a049e61 (reviewer: @davidlowryduda) - [x] 31. 22e43fd (reviewer: @kwankyu) - [x] 32. 19b9da5 (reviewer: @kwankyu) - [x] 33. e2b4155 (reviewer: @kwankyu) - [x] 34. fa498ef (reviewer: @kwankyu) - [x] 35. 5adb22a (reviewer: @kwankyu) - [x] 36. 5410d08 (reviewer: @kwankyu) - [x] 37. d29c4ed (reviewer: @kwankyu) - [x] 38. babffff (reviewer: @kwankyu) - [x] 39. 16c9892 (reviewer: @kwankyu) - [x] 40. 055b9cf (reviewer: @kwankyu) - [x] 41. b6d2649 (reviewer: @kwankyu) - [x] 42. 9c9ec6d (reviewer: @kwankyu) - [x] 43. dc17b6c (reviewer: @kwankyu) - [x] 44. 629d9c2 (reviewer: @kwankyu) - [x] 45. 60fc897 (reviewer: @kwankyu) - [x] 46. 0b60f4f (reviewer: @kwankyu) - [x] 47. 1669486 (reviewer: @kwankyu) - [x] 48. aaf8cc8 (reviewer: @kwankyu) - [x] 49. d7d1ce3 (reviewer: @kwankyu) - [x] 50. e5b7753 (reviewer: @kwankyu) - [x] 51. 3e0473a (reviewer: @kwankyu) - [x] 52. ae07ccc (reviewer: @kwankyu) - [x] 53. 0995121 (merge) - [x] 54. 6b3aeff (reviewer: @kwankyu) - [x] 55. 6d8aa62 (reviewer: @kwankyu) - [x] 56. db6bec5 (reviewer: @kwankyu) - [x] 57. 75abe85 (reviewer: @kwankyu) - [x] 58. 7abd33c (reviewer: @kwankyu) - [x] 59. 07dd3f3 (reviewer: @kwankyu) - [x] 60. eb1f83b (reviewer: @kwankyu) - [x] 61. 61956fd (reviewer: @kwankyu) - [x] 62. 5696a97 (reviewer: @kwankyu) - [x] 63. b6ee3a2 (merge) - [x] 64. 53dad87 (reviewer: @kwankyu) - [x] 65. 032518d (reviewer: @kwankyu) - [x] 66. d97c1c7 (reviewer: @kwankyu) - [x] 67. f55ced3 (reviewer: @kwankyu) - [x] 68. 53aa5f0 (reviewer: @kwankyu) - [x] 69. be0d4dc (reviewer: @kwankyu) - [x] 70. 7ab69d4 (reviewer: @kwankyu) - [x] 71. 7754584 (reviewer: @kwankyu) - [x] 72. 6964c2f (reviewer: @kwankyu) - [x] 73. d176a3e (reviewer: @kwankyu) - [x] 74. 554d014 (reviewer: @kwankyu) - [x] 75. 6f1efc4 (reviewer: @kwankyu) - [x] 76. 4b8708e (reviewer: @kwankyu) - [x] 77. c8f546f (reviewer: @kwankyu) - [x] 78. d4a3ce9 (reviewer: @kwankyu) - [x] 79. 8f00496 (reviewer: @kwankyu) - [x] 80. 56f8390 (merge) - [x] 81. 41893fd (reviewer: @kwankyu) - [x] 82. d1c6631 (reviewer: @kwankyu) - [x] 83. 884363e (reviewer: @kwankyu) - [x] 84. 7162abb (reviewer: @kwankyu) - [x] 85. cbb9326 (merge) - [x] 86. 398226f (reviewer: @kwankyu) - [x] 87. 06c897c (merge) - [x] 88. 9456ded (merge) - [x] 89. 4d8caaa (merge) - [x] 90. 02e5da6 (merge) - [x] 91. beeb935 (lint) - [x] 92. f278392 (preemptive merge) - [x] 93. 588fddb (reviewer: @kwankyu) URL: sagemath#38155 Reported by: gmou3 Reviewer(s): David Lowry-Duda, Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Aug 3, 2024
Large scale formatting of the docstrings in accordance with the [Developer Guide](https://doc.sagemath.org/html/en/developer/coding_basics.html). The changes are done by applying `regex` rules followed by manual checks and edits. The commits will be kept in manageable sizes (of ~100 changed files). Similar preceding PR: sagemath#38145. ### Changes - `True`, `False`, `None`, `self` to ` ``True`` `, ` ``False`` `, ` ``None`` `, ` ``self`` ` - `- arg (type, default: val) -- description` to `- ``arg`` -- type (default: val); description` - First docstring sentences: enforce prescriptive form of initial verb and add missing full stops - Remove full stops from single-sentence `INPUT` argument descriptions - One-line `OUTPUT`s for short output descriptions - More math (`<math>` to `` `<math>` `` and ` ``<math>`` ` to `` `<math>` `` ) - Remove redundant whitespace ### Extra changes (not reflected in the Guide) - `non-negative`, `non-zero`, `non-positive` to `nonnegative`, `nonzero`, `nonpositive` - `"<string>"` to `'<string>'` ### Partial reviews by commit - [x] 01. 5219d62 (reviewer: @kwankyu) - [x] 02. 37fe9ec (reviewer: @davidlowryduda) - [x] 03. 1ed6ea5 (reviewer: @davidlowryduda) - [x] 04. a6b0382 (reviewer: @davidlowryduda) - [x] 05. c284b26 (reviewer: @davidlowryduda) - [x] 06. 021184a (reviewer: @davidlowryduda) - [x] 07. 713e80d (reviewer: @davidlowryduda) - [x] 08. 53ea68f (reviewer: @davidlowryduda) - [x] 09. 198e7ea (stash) - [x] 10. f8b7351 (merge) - [x] 11. 14a3682 (reviewer: @kwankyu) - [x] 12. 9eab12f (reviewer: @kwankyu) - [x] 13. 6c70e9e (reviewer: @kwankyu) - [x] 14. c9f4492 (reviewer: @kwankyu) - [x] 15. ad120b6 (merge) - [x] 16. 75b4801 (reviewer: @kwankyu) - [x] 17. 6922a4c (reviewer: @kwankyu) - [x] 18. 0716b41 (reviewer: @kwankyu) - [x] 19. 5f652ff (reviewer: @kwankyu) - [x] 20. f0445a3 (reviewer: @kwankyu) - [x] 21. 114c977 (reviewer: @kwankyu) - [x] 22. 068ba37 (reviewer: @davidlowryduda) - [x] 23. b0f1279 (reviewer: @kwankyu) - [x] 24. 03a7b01 (reviewer: @davidlowryduda) - [x] 25. db885d1 (reviewer: @kwankyu) - [x] 26. 33550bd (reviewer: @kwankyu) - [x] 27. d41de45 (reviewer: @kwankyu) - [x] 28. a2e9564 (reviewer: @kwankyu) - [x] 29. c0080c6 (reviewer: @kwankyu) - [x] 30. a049e61 (reviewer: @davidlowryduda) - [x] 31. 22e43fd (reviewer: @kwankyu) - [x] 32. 19b9da5 (reviewer: @kwankyu) - [x] 33. e2b4155 (reviewer: @kwankyu) - [x] 34. fa498ef (reviewer: @kwankyu) - [x] 35. 5adb22a (reviewer: @kwankyu) - [x] 36. 5410d08 (reviewer: @kwankyu) - [x] 37. d29c4ed (reviewer: @kwankyu) - [x] 38. babffff (reviewer: @kwankyu) - [x] 39. 16c9892 (reviewer: @kwankyu) - [x] 40. 055b9cf (reviewer: @kwankyu) - [x] 41. b6d2649 (reviewer: @kwankyu) - [x] 42. 9c9ec6d (reviewer: @kwankyu) - [x] 43. dc17b6c (reviewer: @kwankyu) - [x] 44. 629d9c2 (reviewer: @kwankyu) - [x] 45. 60fc897 (reviewer: @kwankyu) - [x] 46. 0b60f4f (reviewer: @kwankyu) - [x] 47. 1669486 (reviewer: @kwankyu) - [x] 48. aaf8cc8 (reviewer: @kwankyu) - [x] 49. d7d1ce3 (reviewer: @kwankyu) - [x] 50. e5b7753 (reviewer: @kwankyu) - [x] 51. 3e0473a (reviewer: @kwankyu) - [x] 52. ae07ccc (reviewer: @kwankyu) - [x] 53. 0995121 (merge) - [x] 54. 6b3aeff (reviewer: @kwankyu) - [x] 55. 6d8aa62 (reviewer: @kwankyu) - [x] 56. db6bec5 (reviewer: @kwankyu) - [x] 57. 75abe85 (reviewer: @kwankyu) - [x] 58. 7abd33c (reviewer: @kwankyu) - [x] 59. 07dd3f3 (reviewer: @kwankyu) - [x] 60. eb1f83b (reviewer: @kwankyu) - [x] 61. 61956fd (reviewer: @kwankyu) - [x] 62. 5696a97 (reviewer: @kwankyu) - [x] 63. b6ee3a2 (merge) - [x] 64. 53dad87 (reviewer: @kwankyu) - [x] 65. 032518d (reviewer: @kwankyu) - [x] 66. d97c1c7 (reviewer: @kwankyu) - [x] 67. f55ced3 (reviewer: @kwankyu) - [x] 68. 53aa5f0 (reviewer: @kwankyu) - [x] 69. be0d4dc (reviewer: @kwankyu) - [x] 70. 7ab69d4 (reviewer: @kwankyu) - [x] 71. 7754584 (reviewer: @kwankyu) - [x] 72. 6964c2f (reviewer: @kwankyu) - [x] 73. d176a3e (reviewer: @kwankyu) - [x] 74. 554d014 (reviewer: @kwankyu) - [x] 75. 6f1efc4 (reviewer: @kwankyu) - [x] 76. 4b8708e (reviewer: @kwankyu) - [x] 77. c8f546f (reviewer: @kwankyu) - [x] 78. d4a3ce9 (reviewer: @kwankyu) - [x] 79. 8f00496 (reviewer: @kwankyu) - [x] 80. 56f8390 (merge) - [x] 81. 41893fd (reviewer: @kwankyu) - [x] 82. d1c6631 (reviewer: @kwankyu) - [x] 83. 884363e (reviewer: @kwankyu) - [x] 84. 7162abb (reviewer: @kwankyu) - [x] 85. cbb9326 (merge) - [x] 86. 398226f (reviewer: @kwankyu) - [x] 87. 06c897c (merge) - [x] 88. 9456ded (merge) - [x] 89. 4d8caaa (merge) - [x] 90. 02e5da6 (merge) - [x] 91. beeb935 (lint) - [x] 92. f278392 (preemptive merge) - [x] 93. 588fddb (reviewer: @kwankyu) URL: sagemath#38155 Reported by: gmou3 Reviewer(s): David Lowry-Duda, 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.
Separate
``x, y``to``x``, ``y``and remove excessive newlines.