gh-38155: docstrings: large scale formatting
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: #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: https://github.com/sagemath/sage/pull/38155
Reported by: gmou3
Reviewer(s): David Lowry-Duda, Kwankyu Lee
