Skip to content

Commit 5185f1f

Browse files
author
Release Manager
committed
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. ### 📝 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 - #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: #36229 Reported by: MedantSharan Reviewer(s): John H. Palmieri, Matthias Köppe, MedantSharan
2 parents ae9be4f + e81a91c commit 5185f1f

File tree

106 files changed

+160
-160
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+160
-160
lines changed

src/doc/en/developer/coding_in_other.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -714,7 +714,7 @@ dumps the user into an Octave interactive shell:
714714
715715
OUTPUT:
716716
717-
An list x (if it exists) which solves M*x = b
717+
A list x (if it exists) which solves M*x = b
718718
719719
EXAMPLES::
720720

src/doc/en/developer/review.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ the patches have been applied to a given release, the issue would
134134
remain in limbo.
135135

136136
**No Patch Bombs**: Code that goes into Sage is peer-reviewed. If
137-
you show up with an 80,000 lines of code bundle that completely
137+
you show up with 80,000 lines of code bundle that completely
138138
rips out a subsystem and replaces it with something else, you can
139139
imagine that the review process will be a little tedious. These
140140
huge patch bombs are problematic for several reasons and we prefer

src/doc/en/reference/coercion/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ Methods to implement
323323
the function is called on the potential codomain. To indicate that
324324
there is no coercion from S to R (self), return ``False`` or
325325
``None``. This is the default behavior. If there is a coercion,
326-
return ``True`` (in which case an morphism using
326+
return ``True`` (in which case a morphism using
327327
``R._element_constructor_`` will be created) or an actual
328328
:class:`Morphism` object with S as the domain and R as the codomain.
329329

src/doc/en/thematic_tutorials/explicit_methods_in_number_theory/elliptic_curves.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Cremona's Databases
55
-------------------
66

77
Cremona's databases of elliptic curves are part of Sage. The curves up
8-
to conductor 10,000 come standard with Sage, and an there is an optional
8+
to conductor 10,000 come standard with Sage, and there is an optional
99
download to gain access to his complete tables. From a shell, you
1010
should run ::
1111

src/doc/en/thematic_tutorials/numerical_sage/f2py.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ you only care about its value before the function is called not
204204
afterwards. So in the above n tells us how many fiboncci numbers to
205205
compute we need to specify this as an input, however we don't need
206206
to get n back as it doesn't contain anything new. Similarly A is
207-
intent(out) so we don't need A to have an specific value
207+
intent(out) so we don't need A to have a specific value
208208
beforehand, we just care about the contents afterwards. F2py
209209
generates a Python function so you only pass those declared
210210
intent(in) and supplies empty workspaces for the remaining

src/doc/en/thematic_tutorials/sandpile.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2865,7 +2865,7 @@ SandpileConfig
28652865

28662866
**\***
28672867

2868-
If ``other`` is an configuration, the recurrent element equivalent
2868+
If ``other`` is a configuration, the recurrent element equivalent
28692869
to the sum. If ``other`` is an integer, the sum of configuration with
28702870
itself ``other`` times.
28712871

src/sage/algebras/commutative_dga.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3087,7 +3087,7 @@ def is_cohomologous_to(self, other):
30873087

30883088
def cohomology_class(self):
30893089
r"""
3090-
Return the cohomology class of an homogeneous cycle, as an element
3090+
Return the cohomology class of a homogeneous cycle, as an element
30913091
of the corresponding cohomology group.
30923092
30933093
EXAMPLES::

src/sage/algebras/hecke_algebras/cubic_hecke_algebra.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1458,7 +1458,7 @@ def one_basis(self):
14581458
def _an_element_(self):
14591459
r"""
14601460
Overwrite the original method from :mod:`~sage.combinat.free_module`
1461-
to obtain an more interesting element for ``TestSuite``.
1461+
to obtain a more interesting element for ``TestSuite``.
14621462
14631463
EXAMPLES::
14641464
@@ -2233,7 +2233,7 @@ def _braid_image_by_basis_extension(self, braid_tietze):
22332233
sage: CHA5._basis_extension
22342234
[[4], [-4], [4, 1]]
22352235
2236-
case where the braid already has an corresponding basis element::
2236+
case where the braid already has a corresponding basis element::
22372237
22382238
sage: CHA5._braid_image_by_basis_extension((1,)) # optional - database_cubic_hecke
22392239
c0

src/sage/algebras/quantum_groups/fock_space.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ class FockSpace(Parent, UniqueRepresentation):
166166
167167
To go between the canonical basis and the natural basis, for level 1
168168
Fock space, we follow the LLT algorithm [LLT1996]_. Indeed, we first
169-
construct an basis `\{ A(\nu) \}` that is an approximation to the
169+
construct a basis `\{ A(\nu) \}` that is an approximation to the
170170
lower global crystal basis, in the sense that it is bar-invariant,
171171
and then use Gaussian elimination to construct the lower global
172172
crystal basis. For higher level Fock space, we follow [Fayers2010]_,

src/sage/calculus/interpolators.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def polygon_spline(pts):
5555
....: [lambda x: ps.derivative(real(x))], 0)
5656
sage: show(m.plot_colored() + m.plot_spiderweb()) # needs sage.plot
5757
58-
Polygon approximation of an circle::
58+
Polygon approximation of a circle::
5959
6060
sage: pts = [e^(I*t / 25) for t in range(25)]
6161
sage: ps = polygon_spline(pts)

0 commit comments

Comments
 (0)