Skip to content

Commit babffff

Browse files
gmou3gmou3
committed
Docstring edits
"Implements" to "Implement". Add more fullstops on docstrings's first sentence.
1 parent d29c4ed commit babffff

94 files changed

Lines changed: 302 additions & 300 deletions

File tree

Some content is hidden

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

‎src/sage/algebras/hecke_algebras/cubic_hecke_base_ring.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -804,7 +804,7 @@ def field_embedding(self, characteristic=0):
804804
805805
INPUT:
806806
807-
- ``characteristic`` -- integer (default: ``0``); the characteristic
807+
- ``characteristic`` -- integer (default: `0`); the characteristic
808808
of the field
809809
810810
EXAMPLES::

‎src/sage/calculus/riemann.pyx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ cdef class Riemann_Map:
101101
102102
The following inputs may be passed in as named parameters:
103103
104-
- ``N`` -- integer (default: ``500``); the number of collocation points
104+
- ``N`` -- integer (default: `500`); the number of collocation points
105105
used to compute the map. More points will give more accurate results,
106106
especially near the boundaries, but will take longer to compute.
107107
@@ -112,7 +112,7 @@ cdef class Riemann_Map:
112112
The following inputs may be passed as named parameters in unusual
113113
circumstances:
114114
115-
- ``ncorners`` -- integer (default: ``4``); if mapping a figure with
115+
- ``ncorners`` -- integer (default: `4`); if mapping a figure with
116116
(equally t-spaced) corners -- corners that make a significant change in
117117
the direction of the boundary -- better results may be sometimes obtained by
118118
accurately giving this parameter. Used to add the proper constant to
@@ -381,7 +381,7 @@ cdef class Riemann_Map:
381381
382382
The following inputs may be passed in as named parameters:
383383
384-
- ``boundary`` -- integer (default: ``-1``); if < 0,
384+
- ``boundary`` -- integer (default: `-1`); if < 0,
385385
:meth:`get_theta_points` will return the points for all boundaries.
386386
If >= 0, :meth:`get_theta_points` will return only the points for
387387
the boundary specified.
@@ -461,7 +461,7 @@ cdef class Riemann_Map:
461461
462462
The following input must all be passed in as named parameters:
463463
464-
- ``boundary`` -- integer (default: ``-1``); if < 0,
464+
- ``boundary`` -- integer (default: `-1`); if < 0,
465465
``get_theta_points()`` will return the points for all boundaries.
466466
If >= 0, ``get_theta_points()`` will return only the points for
467467
the boundary specified.
@@ -847,13 +847,13 @@ cdef class Riemann_Map:
847847
848848
The following inputs may be passed in as named parameters:
849849
850-
- ``spokes`` -- integer (default: ``16``); the number of equally
850+
- ``spokes`` -- integer (default: `16`); the number of equally
851851
spaced radial lines to plot
852852
853-
- ``circles`` -- integer (default: ``4``); the number of equally
853+
- ``circles`` -- integer (default: `4`); the number of equally
854854
spaced circles about the center to plot
855855
856-
- ``pts`` -- integer (default: ``32``); the number of points to
856+
- ``pts`` -- integer (default: `32`); the number of points to
857857
plot. Each radial line is made by ``1*pts`` points, each circle
858858
has ``2*pts`` points. Note that high values may cause erratic
859859
behavior of the radial lines near the boundaries.
@@ -877,7 +877,7 @@ cdef class Riemann_Map:
877877
- ``withcolor`` -- boolean (default: ``False``); if ``True``,
878878
the spiderweb will be overlaid on the basic color plot
879879
880-
- ``plot_points`` -- integer (default: ``200``); the size of the grid
880+
- ``plot_points`` -- integer (default: `200`); the size of the grid
881881
in the x direction. The number of points in the y_direction is scaled
882882
accordingly. Note that very large values can cause this function to
883883
run slowly.
@@ -1013,7 +1013,7 @@ cdef class Riemann_Map:
10131013
``(xmin, xmax, ymin, ymax)``. Declare if you do not want the plot
10141014
to use the default range for the figure.
10151015
1016-
- ``plot_points`` -- integer (default: ``100``); number of points to
1016+
- ``plot_points`` -- integer (default: `100`); number of points to
10171017
plot in the x direction. Points in the y direction are scaled
10181018
accordingly. Note that very large values can cause this function to
10191019
run slowly.

‎src/sage/calculus/transforms/dft.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ def index_object(self):
203203

204204
def _repr_(self):
205205
"""
206-
Implements print method.
206+
Implement print method.
207207
208208
EXAMPLES::
209209
@@ -574,7 +574,7 @@ def convolution_periodic(self, other):
574574

575575
def __mul__(self, other):
576576
"""
577-
Implements scalar multiplication (on the right).
577+
Implement scalar multiplication (on the right).
578578
579579
EXAMPLES::
580580
@@ -594,7 +594,7 @@ def __mul__(self, other):
594594

595595
def __eq__(self, other):
596596
"""
597-
Implements boolean equals.
597+
Implement boolean equals.
598598
599599
EXAMPLES::
600600
@@ -664,7 +664,7 @@ def fft(self):
664664

665665
def ifft(self):
666666
"""
667-
Implements the gsl ``FastFourierTransform.inverse`` in
667+
Implement the gsl ``FastFourierTransform.inverse`` in
668668
:mod:`~sage.calculus.transforms.fft`.
669669
670670
If the number of sample points in the input is a power of 2
@@ -765,7 +765,7 @@ def dwt(self, other='haar', wavelet_k=2):
765765

766766
def idwt(self, other='haar', wavelet_k=2):
767767
r"""
768-
Implements the gsl ``WaveletTransform.backward()`` in
768+
Implement the gsl ``WaveletTransform.backward()`` in
769769
:mod:`~sage.calculus.transforms.dwt`.
770770
771771
Assumes the length of the sample is a power of 2. Uses the

‎src/sage/categories/algebras_with_basis.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,6 @@ def product_on_basis(self, t1, t2):
372372

373373
class ElementMethods:
374374
"""
375-
Implements operations on elements of tensor products of algebras with basis
375+
Implement operations on elements of tensor products of algebras with basis
376376
"""
377377
pass

‎src/sage/categories/examples/finite_coxeter_groups.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ def __contains__(self, x):
135135
@cached_method
136136
def one(self):
137137
r"""
138-
Implements :meth:`Monoids.ParentMethods.one`.
138+
Implement :meth:`Monoids.ParentMethods.one`.
139139
140140
EXAMPLES::
141141
@@ -147,7 +147,7 @@ def one(self):
147147

148148
def index_set(self):
149149
r"""
150-
Implements :meth:`CoxeterGroups.ParentMethods.index_set`.
150+
Implement :meth:`CoxeterGroups.ParentMethods.index_set`.
151151
152152
EXAMPLES::
153153
@@ -187,7 +187,7 @@ class Element(ElementWrapper):
187187

188188
def has_right_descent(self, i, positive=False, side='right'):
189189
r"""
190-
Implements :meth:`SemiGroups.ElementMethods.has_right_descent`.
190+
Implement :meth:`SemiGroups.ElementMethods.has_right_descent`.
191191
192192
EXAMPLES::
193193
@@ -222,7 +222,7 @@ def has_right_descent(self, i, positive=False, side='right'):
222222

223223
def apply_simple_reflection_right(self, i):
224224
r"""
225-
Implements :meth:`CoxeterGroups.ElementMethods.apply_simple_reflection`.
225+
Implement :meth:`CoxeterGroups.ElementMethods.apply_simple_reflection`.
226226
227227
EXAMPLES::
228228

‎src/sage/categories/examples/finite_weyl_groups.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def _repr_(self):
9797
@cached_method
9898
def one(self):
9999
"""
100-
Implements :meth:`Monoids.ParentMethods.one`.
100+
Implement :meth:`Monoids.ParentMethods.one`.
101101
102102
EXAMPLES::
103103
@@ -108,7 +108,7 @@ def one(self):
108108

109109
def index_set(self):
110110
"""
111-
Implements :meth:`CoxeterGroups.ParentMethods.index_set`.
111+
Implement :meth:`CoxeterGroups.ParentMethods.index_set`.
112112
113113
EXAMPLES::
114114
@@ -146,7 +146,7 @@ def cartan_type(self):
146146

147147
def product(self, x, y):
148148
"""
149-
Implements :meth:`Semigroups.ParentMethods.product`.
149+
Implement :meth:`Semigroups.ParentMethods.product`.
150150
151151
EXAMPLES::
152152
@@ -175,7 +175,7 @@ class Element(ElementWrapper):
175175

176176
def has_right_descent(self, i):
177177
"""
178-
Implements :meth:`CoxeterGroups.ElementMethods.has_right_descent`.
178+
Implement :meth:`CoxeterGroups.ElementMethods.has_right_descent`.
179179
180180
EXAMPLES::
181181

‎src/sage/categories/examples/sets_cat.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ def _repr_(self):
106106

107107
def an_element(self):
108108
"""
109-
Implements :meth:`Sets.ParentMethods.an_element`.
109+
Implement :meth:`Sets.ParentMethods.an_element`.
110110
111111
TESTS::
112112
@@ -186,7 +186,7 @@ def _repr_(self):
186186

187187
def an_element(self):
188188
"""
189-
Implements :meth:`Sets.ParentMethods.an_element`.
189+
Implement :meth:`Sets.ParentMethods.an_element`.
190190
191191
TESTS::
192192

‎src/sage/categories/graded_algebras_with_basis.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ def extra_super_categories(self):
175175

176176
class ParentMethods:
177177
"""
178-
Implements operations on tensor products of super algebras
178+
Implement operations on tensor products of super algebras
179179
with basis.
180180
"""
181181
@cached_method

‎src/sage/categories/graded_lie_algebras.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ class FiniteDimensional(CategoryWithAxiom_over_base_ring):
7474
"""
7575
def extra_super_categories(self):
7676
"""
77-
Implements the fact that a finite dimensional stratified Lie
77+
Implement the fact that a finite dimensional stratified Lie
7878
algebra is nilpotent.
7979
8080
EXAMPLES::

‎src/sage/categories/highest_weight_crystals.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,7 @@ def extra_super_categories(self):
669669

670670
class ParentMethods:
671671
"""
672-
Implements operations on tensor products of crystals.
672+
Implement operations on tensor products of crystals.
673673
"""
674674
@cached_method
675675
def highest_weight_vectors(self):

0 commit comments

Comments
 (0)