Fixed grammatical errors at multiple points in English documentation #36229
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
mkoeppe
reviewed
Sep 9, 2023
mkoeppe
reviewed
Sep 9, 2023
mkoeppe
reviewed
Sep 9, 2023
mkoeppe
reviewed
Sep 9, 2023
|
Other than the comments from @mkoeppe this looks good. It may be hard to get it merged — it touches so many files that there are likely to be merge conflicts. I would suggest for similar changes in the future, break it up into small pieces, with each piece handling (for instance) 5-10 files. |
mkoeppe
reviewed
Dec 18, 2023
mkoeppe
reviewed
Dec 18, 2023
mkoeppe
reviewed
Dec 18, 2023
|
Documentation preview for this PR (built with commit e81a91c; changes) is ready! 🎉 |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Dec 21, 2023
sagemathgh-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 sagemath#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. ### 📝 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. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36229 Reported by: MedantSharan Reviewer(s): John H. Palmieri, Matthias Köppe, MedantSharan
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Dec 22, 2023
sagemathgh-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 sagemath#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. ### 📝 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. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36229 Reported by: MedantSharan Reviewer(s): John H. Palmieri, Matthias Köppe, MedantSharan
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Dec 23, 2023
sagemathgh-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 sagemath#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. ### 📝 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. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36229 Reported by: MedantSharan Reviewer(s): John H. Palmieri, Matthias Köppe, MedantSharan
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Dec 24, 2023
sagemathgh-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 sagemath#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. ### 📝 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. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36229 Reported by: MedantSharan Reviewer(s): John H. Palmieri, Matthias Köppe, MedantSharan
|
hello, has this issue been resolved completely? |
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.
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.
📝 Checklist
⌛ Dependencies