Commit
2 years ago
gh-36229: Fixed grammatical errors at multiple points in English documentation There were various grammatical errors, mostly pertaining to the use of English articles "a" and "an" with corresponding nouns, all of which have now exhaustively been fixed. This also fixes Issue #35642. This fix makes the documentation in English more readable and improves developer experience. All the changes for article-noun agreement are in accordance to American English standards. I used VSCode's regular expression search to find out all the instances of erroneous article usage and changed them manually. Some examples are given below. `src\sage\schemes\toric\library.py: * This is an example of an non-polyhedral fan.` `src\sage\schemes\hyperelliptic_curves\jacobian_generic.py: An more extended example, demonstrating arithmetic... src\sage\rings\number_field\S_unit_solver.py: # Note that l is the an lower bound on the square of the magnitude...` The lines above have respectively been changed to: `src\sage\schemes\toric\library.py: * This is an example of a non-polyhedral fan.` `src\sage\schemes\hyperelliptic_curves\jacobian_generic.py: A more extended example, demonstrating arithmetic... src\sage\rings\number_field\S_unit_solver.py: # Note that l is the lower bound on the square of the magnitude...` All the changes are only in the documentation/comments at various places in the project. There were some instances where "an" had to be changed to "and" or some other word, but they were very few. Most required changing it to "a" or completely removing the article. ### :memo: Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [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. - [x] I have updated the documentation accordingly. ### :hourglass: Dependencies <!-- List all open PRs that this PR logically depends on - #12345: short description why this is a dependency - #34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: https://github.com/sagemath/sage/pull/36229 Reported by: MedantSharan Reviewer(s): John H. Palmieri, Matthias Köppe, MedantSharan
Author
Release Manager
Loading