Skip to content

Commit

Permalink
Docstring edits
Browse files Browse the repository at this point in the history
"Implements" to "Implement". Add more fullstops on docstrings's first sentence.
  • Loading branch information
gmou3 committed Jun 16, 2024
1 parent d29c4ed commit babffff
Show file tree
Hide file tree
Showing 94 changed files with 302 additions and 300 deletions.
2 changes: 1 addition & 1 deletion src/sage/algebras/hecke_algebras/cubic_hecke_base_ring.py
Original file line number Diff line number Diff line change
Expand Up @@ -804,7 +804,7 @@ def field_embedding(self, characteristic=0):
INPUT:
- ``characteristic`` -- integer (default: ``0``); the characteristic
- ``characteristic`` -- integer (default: `0`); the characteristic
of the field
EXAMPLES::
Expand Down
18 changes: 9 additions & 9 deletions src/sage/calculus/riemann.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ cdef class Riemann_Map:
The following inputs may be passed in as named parameters:
- ``N`` -- integer (default: ``500``); the number of collocation points
- ``N`` -- integer (default: `500`); the number of collocation points
used to compute the map. More points will give more accurate results,
especially near the boundaries, but will take longer to compute.
Expand All @@ -112,7 +112,7 @@ cdef class Riemann_Map:
The following inputs may be passed as named parameters in unusual
circumstances:
- ``ncorners`` -- integer (default: ``4``); if mapping a figure with
- ``ncorners`` -- integer (default: `4`); if mapping a figure with
(equally t-spaced) corners -- corners that make a significant change in
the direction of the boundary -- better results may be sometimes obtained by
accurately giving this parameter. Used to add the proper constant to
Expand Down Expand Up @@ -381,7 +381,7 @@ cdef class Riemann_Map:
The following inputs may be passed in as named parameters:
- ``boundary`` -- integer (default: ``-1``); if < 0,
- ``boundary`` -- integer (default: `-1`); if < 0,
:meth:`get_theta_points` will return the points for all boundaries.
If >= 0, :meth:`get_theta_points` will return only the points for
the boundary specified.
Expand Down Expand Up @@ -461,7 +461,7 @@ cdef class Riemann_Map:
The following input must all be passed in as named parameters:
- ``boundary`` -- integer (default: ``-1``); if < 0,
- ``boundary`` -- integer (default: `-1`); if < 0,
``get_theta_points()`` will return the points for all boundaries.
If >= 0, ``get_theta_points()`` will return only the points for
the boundary specified.
Expand Down Expand Up @@ -847,13 +847,13 @@ cdef class Riemann_Map:
The following inputs may be passed in as named parameters:
- ``spokes`` -- integer (default: ``16``); the number of equally
- ``spokes`` -- integer (default: `16`); the number of equally
spaced radial lines to plot
- ``circles`` -- integer (default: ``4``); the number of equally
- ``circles`` -- integer (default: `4`); the number of equally
spaced circles about the center to plot
- ``pts`` -- integer (default: ``32``); the number of points to
- ``pts`` -- integer (default: `32`); the number of points to
plot. Each radial line is made by ``1*pts`` points, each circle
has ``2*pts`` points. Note that high values may cause erratic
behavior of the radial lines near the boundaries.
Expand All @@ -877,7 +877,7 @@ cdef class Riemann_Map:
- ``withcolor`` -- boolean (default: ``False``); if ``True``,
the spiderweb will be overlaid on the basic color plot
- ``plot_points`` -- integer (default: ``200``); the size of the grid
- ``plot_points`` -- integer (default: `200`); the size of the grid
in the x direction. The number of points in the y_direction is scaled
accordingly. Note that very large values can cause this function to
run slowly.
Expand Down Expand Up @@ -1013,7 +1013,7 @@ cdef class Riemann_Map:
``(xmin, xmax, ymin, ymax)``. Declare if you do not want the plot
to use the default range for the figure.
- ``plot_points`` -- integer (default: ``100``); number of points to
- ``plot_points`` -- integer (default: `100`); number of points to
plot in the x direction. Points in the y direction are scaled
accordingly. Note that very large values can cause this function to
run slowly.
Expand Down
10 changes: 5 additions & 5 deletions src/sage/calculus/transforms/dft.py
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ def index_object(self):

def _repr_(self):
"""
Implements print method.
Implement print method.
EXAMPLES::
Expand Down Expand Up @@ -574,7 +574,7 @@ def convolution_periodic(self, other):

def __mul__(self, other):
"""
Implements scalar multiplication (on the right).
Implement scalar multiplication (on the right).
EXAMPLES::
Expand All @@ -594,7 +594,7 @@ def __mul__(self, other):

def __eq__(self, other):
"""
Implements boolean equals.
Implement boolean equals.
EXAMPLES::
Expand Down Expand Up @@ -664,7 +664,7 @@ def fft(self):

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

def idwt(self, other='haar', wavelet_k=2):
r"""
Implements the gsl ``WaveletTransform.backward()`` in
Implement the gsl ``WaveletTransform.backward()`` in
:mod:`~sage.calculus.transforms.dwt`.
Assumes the length of the sample is a power of 2. Uses the
Expand Down
2 changes: 1 addition & 1 deletion src/sage/categories/algebras_with_basis.py
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,6 @@ def product_on_basis(self, t1, t2):

class ElementMethods:
"""
Implements operations on elements of tensor products of algebras with basis
Implement operations on elements of tensor products of algebras with basis
"""
pass
8 changes: 4 additions & 4 deletions src/sage/categories/examples/finite_coxeter_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ def __contains__(self, x):
@cached_method
def one(self):
r"""
Implements :meth:`Monoids.ParentMethods.one`.
Implement :meth:`Monoids.ParentMethods.one`.
EXAMPLES::
Expand All @@ -147,7 +147,7 @@ def one(self):

def index_set(self):
r"""
Implements :meth:`CoxeterGroups.ParentMethods.index_set`.
Implement :meth:`CoxeterGroups.ParentMethods.index_set`.
EXAMPLES::
Expand Down Expand Up @@ -187,7 +187,7 @@ class Element(ElementWrapper):

def has_right_descent(self, i, positive=False, side='right'):
r"""
Implements :meth:`SemiGroups.ElementMethods.has_right_descent`.
Implement :meth:`SemiGroups.ElementMethods.has_right_descent`.
EXAMPLES::
Expand Down Expand Up @@ -222,7 +222,7 @@ def has_right_descent(self, i, positive=False, side='right'):

def apply_simple_reflection_right(self, i):
r"""
Implements :meth:`CoxeterGroups.ElementMethods.apply_simple_reflection`.
Implement :meth:`CoxeterGroups.ElementMethods.apply_simple_reflection`.
EXAMPLES::
Expand Down
8 changes: 4 additions & 4 deletions src/sage/categories/examples/finite_weyl_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ def _repr_(self):
@cached_method
def one(self):
"""
Implements :meth:`Monoids.ParentMethods.one`.
Implement :meth:`Monoids.ParentMethods.one`.
EXAMPLES::
Expand All @@ -108,7 +108,7 @@ def one(self):

def index_set(self):
"""
Implements :meth:`CoxeterGroups.ParentMethods.index_set`.
Implement :meth:`CoxeterGroups.ParentMethods.index_set`.
EXAMPLES::
Expand Down Expand Up @@ -146,7 +146,7 @@ def cartan_type(self):

def product(self, x, y):
"""
Implements :meth:`Semigroups.ParentMethods.product`.
Implement :meth:`Semigroups.ParentMethods.product`.
EXAMPLES::
Expand Down Expand Up @@ -175,7 +175,7 @@ class Element(ElementWrapper):

def has_right_descent(self, i):
"""
Implements :meth:`CoxeterGroups.ElementMethods.has_right_descent`.
Implement :meth:`CoxeterGroups.ElementMethods.has_right_descent`.
EXAMPLES::
Expand Down
4 changes: 2 additions & 2 deletions src/sage/categories/examples/sets_cat.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def _repr_(self):

def an_element(self):
"""
Implements :meth:`Sets.ParentMethods.an_element`.
Implement :meth:`Sets.ParentMethods.an_element`.
TESTS::
Expand Down Expand Up @@ -186,7 +186,7 @@ def _repr_(self):

def an_element(self):
"""
Implements :meth:`Sets.ParentMethods.an_element`.
Implement :meth:`Sets.ParentMethods.an_element`.
TESTS::
Expand Down
2 changes: 1 addition & 1 deletion src/sage/categories/graded_algebras_with_basis.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ def extra_super_categories(self):

class ParentMethods:
"""
Implements operations on tensor products of super algebras
Implement operations on tensor products of super algebras
with basis.
"""
@cached_method
Expand Down
2 changes: 1 addition & 1 deletion src/sage/categories/graded_lie_algebras.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class FiniteDimensional(CategoryWithAxiom_over_base_ring):
"""
def extra_super_categories(self):
"""
Implements the fact that a finite dimensional stratified Lie
Implement the fact that a finite dimensional stratified Lie
algebra is nilpotent.
EXAMPLES::
Expand Down
2 changes: 1 addition & 1 deletion src/sage/categories/highest_weight_crystals.py
Original file line number Diff line number Diff line change
Expand Up @@ -669,7 +669,7 @@ def extra_super_categories(self):

class ParentMethods:
"""
Implements operations on tensor products of crystals.
Implement operations on tensor products of crystals.
"""
@cached_method
def highest_weight_vectors(self):
Expand Down
2 changes: 1 addition & 1 deletion src/sage/categories/lie_algebras.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ class FiniteDimensional(CategoryWithAxiom_over_base_ring):

def extra_super_categories(self):
"""
Implements the fact that a finite dimensional Lie algebra over
Implement the fact that a finite dimensional Lie algebra over
a finite ring is finite.
EXAMPLES::
Expand Down
4 changes: 2 additions & 2 deletions src/sage/categories/modules_with_basis.py
Original file line number Diff line number Diff line change
Expand Up @@ -2490,13 +2490,13 @@ def extra_super_categories(self):

class ParentMethods:
"""
Implements operations on tensor products of modules with basis.
Implement operations on tensor products of modules with basis.
"""
pass

class ElementMethods:
"""
Implements operations on elements of tensor products of modules
Implement operations on elements of tensor products of modules
with basis.
"""

Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/affine_permutation.py
Original file line number Diff line number Diff line change
Expand Up @@ -1118,7 +1118,7 @@ def value(self, i):

def position(self, i):
r"""
Find the position `j` such the ``self.value(j)=i``
Find the position `j` such the ``self.value(j)=i``.
EXAMPLES::
Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/backtrack.py
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ def roots(self):

def children(self, x):
r"""
Return the single child ``x+1`` of the integer ``x``
Return the single child ``x+1`` of the integer ``x``.
EXAMPLES::
Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/constellation.py
Original file line number Diff line number Diff line change
Expand Up @@ -1544,7 +1544,7 @@ def perms_are_connected(g, n):

def perms_canonical_labels_from(x, y, j0, verbose=False):
r"""
Return canonical labels for ``x``, ``y`` that starts at ``j0``
Return canonical labels for ``x``, ``y`` that starts at ``j0``.
.. WARNING::
Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/designs/bibd.py
Original file line number Diff line number Diff line change
Expand Up @@ -1179,7 +1179,7 @@ def v_5_1_BIBD(v, check=True):

def _get_r_s_t_u(v):
r"""
Implements the table from [ClaytonSmith]_.
Implement the table from [ClaytonSmith]_.
Return the parameters ``r,s,t,u`` associated with an integer ``v``.
Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/designs/difference_family.py
Original file line number Diff line number Diff line change
Expand Up @@ -832,7 +832,7 @@ def radical_difference_family(K, k, l=1, existence=False, check=True):
- ``K`` -- a finite field
- ``k`` -- positive integer; the size of the blocks
- ``l`` -- integer (default: ``1``); the `\lambda` parameter
- ``l`` -- integer (default: `1`); the `\lambda` parameter
- ``existence`` -- if ``True``, then return either ``True`` if Sage knows
how to build such design, ``Unknown`` if it does not and ``False`` if it
knows that the design does not exist
Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/diagram_algebras.py
Original file line number Diff line number Diff line change
Expand Up @@ -5775,7 +5775,7 @@ def propagating_number(sp):

def to_set_partition(l, k=None):
r"""
Convert input to a set partition of `\{1, \ldots, k, -1, \ldots, -k\}`
Convert input to a set partition of `\{1, \ldots, k, -1, \ldots, -k\}`.
Convert a list of a list of numbers to a set partitions. Each list
of numbers in the outer list specifies the numbers contained in one
Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/e_one_star.py
Original file line number Diff line number Diff line change
Expand Up @@ -1468,7 +1468,7 @@ def __call__(self, patch, iterations=1) -> Patch:
INPUT:
- ``patch`` -- a patch
- ``iterations`` -- integer (default: 1) number of iterations
- ``iterations`` -- integer (default: 1); number of iterations
OUTPUT: a patch
Expand Down
4 changes: 2 additions & 2 deletions src/sage/combinat/free_module.py
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ def __classcall_private__(cls, base_ring, basis_keys=None, category=None,
@lazy_attribute
def element_class(self):
"""
The (default) class for the elements of this parent
The (default) class for the elements of this parent.
Overrides :meth:`Parent.element_class` to force the
construction of Python class. This is currently needed to
Expand Down Expand Up @@ -1799,7 +1799,7 @@ def __init__(self, modules, **options):

def _sets_keys(self):
"""
In waiting for self._sets.keys()
In waiting for ``self._sets.keys()``.
TESTS::
Expand Down
12 changes: 7 additions & 5 deletions src/sage/combinat/k_tableau.py
Original file line number Diff line number Diff line change
Expand Up @@ -670,8 +670,9 @@ class WeakTableau_core(WeakTableau_abstract):
@staticmethod
def __classcall_private__(cls, t, k):
r"""
Implements the shortcut ``WeakTableau_core(t, k)`` to ``WeakTableaux_core(k, shape , weight)(t)``
where ``shape`` is the shape of the tableau and ``weight`` is its weight.
Implement the shortcut ``WeakTableau_core(t, k)`` to
``WeakTableaux_core(k, shape , weight)(t)`` where ``shape`` is the
shape of the tableau and ``weight`` is its weight.
TESTS::
Expand Down Expand Up @@ -1363,8 +1364,9 @@ class WeakTableau_bounded(WeakTableau_abstract):
@staticmethod
def __classcall_private__(cls, t, k):
r"""
Implements the shortcut ``WeakTableau_bounded(t, k)`` to ``WeakTableaux_bounded(k, shape, weight)(t)``
where ``shape`` is the shape of the tableau and ``weight`` is its weight.
Implement the shortcut ``WeakTableau_bounded(t, k)`` to
``WeakTableaux_bounded(k, shape, weight)(t)`` where ``shape`` is the
shape of the tableau and ``weight`` is its weight.
TESTS::
Expand Down Expand Up @@ -1822,7 +1824,7 @@ def straighten_input(t, k):
@staticmethod
def __classcall_private__(cls, t, k, inner_shape=[]):
r"""
Implements the shortcut ``WeakTableau_factorized_permutation(t, k)`` to
Implement the shortcut ``WeakTableau_factorized_permutation(t, k)`` to
``WeakTableaux_factorized_permutation(k, shape, weight)(t)``
where ``shape`` is the shape of the tableau as a `(k+1)`-core (or a tuple of
`(k+1)`-cores if the tableau is skew) and ``weight`` is its weight.
Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/lr_tableau.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class LittlewoodRichardsonTableau(SemistandardTableau):
@staticmethod
def __classcall_private__(cls, t, weight):
r"""
Implements the shortcut ``LittlewoodRichardsonTableau(t, weight)`` to
Implement the shortcut ``LittlewoodRichardsonTableau(t, weight)`` to
``LittlewoodRichardsonTableaux(shape , weight)(t)``
where ``shape`` is the shape of the tableau.
Expand Down
Loading

0 comments on commit babffff

Please sign in to comment.