Skip to content

Commit

Permalink
Suggestions by kwankyu
Browse files Browse the repository at this point in the history
  • Loading branch information
gmou3 committed Jan 20, 2025
1 parent a91ddfe commit 61f6748
Show file tree
Hide file tree
Showing 16 changed files with 86 additions and 88 deletions.
8 changes: 4 additions & 4 deletions src/sage/matroids/basis_matroid.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ cdef class BasisMatroid(BasisExchangeMatroid):
"""
def __init__(self, M=None, groundset=None, bases=None, nonbases=None, rank=None):
"""
See class definition for full documentation.
See the class definition for full documentation.
EXAMPLES::
Expand Down Expand Up @@ -1086,9 +1086,9 @@ cdef class BasisMatroid(BasisExchangeMatroid):
.. WARNING::
This method is linked to __richcmp__ (in Cython) and __cmp__ or
__eq__/__ne__ (in Python). If you override one, you should (and in
Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!
EXAMPLES::
Expand Down
8 changes: 4 additions & 4 deletions src/sage/matroids/circuit_closures_matroid.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ cdef class CircuitClosuresMatroid(Matroid):

def __init__(self, M=None, groundset=None, circuit_closures=None):
"""
Initialization of the matroid. See class docstring for full
Initialization of the matroid. See the class docstring for full
documentation.
EXAMPLES::
Expand Down Expand Up @@ -427,9 +427,9 @@ cdef class CircuitClosuresMatroid(Matroid):
.. WARNING::
This method is linked to __richcmp__ (in Cython) and __cmp__ or
__eq__/__ne__ (in Python). If you override one, you should
(and in Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!
EXAMPLES::
Expand Down
8 changes: 4 additions & 4 deletions src/sage/matroids/circuits_matroid.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ cdef class CircuitsMatroid(Matroid):

def __init__(self, M=None, groundset=None, circuits=None, nsc_defined=False):
"""
Initialization of the matroid. See class docstring for full
Initialization of the matroid. See the class docstring for full
documentation.
TESTS::
Expand Down Expand Up @@ -320,9 +320,9 @@ cdef class CircuitsMatroid(Matroid):
.. WARNING::
This method is linked to __richcmp__ (in Cython) and __cmp__ or
__eq__/__ne__ (in Python). If you override one, you should
(and in Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!
EXAMPLES::
Expand Down
8 changes: 4 additions & 4 deletions src/sage/matroids/dual_matroid.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ class DualMatroid(Matroid):

def __init__(self, matroid):
"""
See class definition for documentation.
See the class definition for documentation.
EXAMPLES::
Expand Down Expand Up @@ -400,9 +400,9 @@ def __hash__(self):
.. WARNING::
This method is linked to __richcmp__ (in Cython) and __cmp__ or
__eq__/__ne__ (in Python). If you override one, you should (and in
Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!
EXAMPLES::
Expand Down
4 changes: 2 additions & 2 deletions src/sage/matroids/extension.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ cdef class LinearSubclasses:
"""
def __init__(self, M, line_length=None, subsets=None, splice=None):
"""
See class docstring for full documentation.
See the class docstring for full documentation.
EXAMPLES::
Expand Down Expand Up @@ -466,7 +466,7 @@ cdef class MatroidExtensions(LinearSubclasses):
"""
def __init__(self, M, e, line_length=None, subsets=None, splice=None, orderly=False):
"""
See class docstring for full documentation.
See the class docstring for full documentation.
EXAMPLES::
Expand Down
8 changes: 4 additions & 4 deletions src/sage/matroids/flats_matroid.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ cdef class FlatsMatroid(Matroid):

def __init__(self, M=None, groundset=None, flats=None):
"""
Initialization of the matroid. See class docstring for full
Initialization of the matroid. See the class docstring for full
documentation.
TESTS::
Expand Down Expand Up @@ -279,9 +279,9 @@ cdef class FlatsMatroid(Matroid):
.. WARNING::
This method is linked to __richcmp__ (in Cython) and __cmp__ or
__eq__/__ne__ (in Python). If you override one, you should
(and in Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!
EXAMPLES::
Expand Down
12 changes: 6 additions & 6 deletions src/sage/matroids/gammoid.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class Gammoid(Matroid):
INPUT:
- ``D`` -- a loopless DiGraph representing the gammoid
- ``D`` -- a loopless digraph representing the gammoid
- ``roots`` -- a subset of the vertices
- ``groundset`` -- (optional) a subset of the vertices
Expand Down Expand Up @@ -89,7 +89,7 @@ class Gammoid(Matroid):

def __init__(self, D, roots, groundset=None):
"""
See class definition for full documentation.
See the class definition for full documentation.
EXAMPLES::
Expand Down Expand Up @@ -203,9 +203,9 @@ def __hash__(self):
.. WARNING::
This method is linked to __richcmp__ (in Cython) and __cmp__ or
__eq__/__ne__ (in Python). If you override one, you should (and in
Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!
EXAMPLES::
Expand Down Expand Up @@ -319,7 +319,7 @@ def __reduce__(self):

def digraph(self):
"""
Return the DiGraph associated with the gammoid.
Return the digraph associated with the gammoid.
EXAMPLES::
Expand Down
8 changes: 4 additions & 4 deletions src/sage/matroids/graphic_matroid.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ cdef class GraphicMatroid(Matroid):

def __init__(self, G, groundset=None):
"""
See class definition for full documentation.
See the class definition for full documentation.
EXAMPLES::
Expand Down Expand Up @@ -342,9 +342,9 @@ cdef class GraphicMatroid(Matroid):
.. WARNING::
This method is linked to __richcmp__ (in Cython) and __cmp__ or
__eq__/__ne__ (in Python). If you override one, you should (and in
Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!
EXAMPLES::
Expand Down
12 changes: 6 additions & 6 deletions src/sage/matroids/lean_matrix.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -673,7 +673,7 @@ cdef class GenericMatrix(LeanMatrix):

def __init__(self, long nrows, long ncols, M=None, ring=None):
"""
See class docstring for full information.
See the class docstring for full information.

EXAMPLES::

Expand Down Expand Up @@ -982,7 +982,7 @@ cdef class BinaryMatrix(LeanMatrix):

def __init__(self, long m, long n, object M=None, object ring=None):
"""
See class docstring for full specification.
See the class docstring for full specification.

EXAMPLES::

Expand Down Expand Up @@ -1605,7 +1605,7 @@ cdef class TernaryMatrix(LeanMatrix):

def __init__(self, long m, long n, M=None, ring=None):
"""
See class docstring for full specification.
See the class docstring for full specification.

EXAMPLES::

Expand Down Expand Up @@ -2157,7 +2157,7 @@ cdef class QuaternaryMatrix(LeanMatrix):

def __init__(self, long m, long n, M=None, ring=None):
"""
See class docstring for full specification.
See the class docstring for full specification.

EXAMPLES::

Expand Down Expand Up @@ -2775,7 +2775,7 @@ cdef class PlusMinusOneMatrix(LeanMatrix):

def __init__(self, long nrows, long ncols, M=None, ring=None):
"""
See class docstring for full information.
See the class docstring for full information.

EXAMPLES::

Expand Down Expand Up @@ -3209,7 +3209,7 @@ cdef class RationalMatrix(LeanMatrix):

def __init__(self, long nrows, long ncols, M=None, ring=None):
"""
See class docstring for full information.
See the class docstring for full information.

EXAMPLES::

Expand Down
16 changes: 8 additions & 8 deletions src/sage/matroids/linear_matroid.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ cdef class LinearMatroid(BasisExchangeMatroid):
"""
def __init__(self, matrix=None, groundset=None, reduced_matrix=None, ring=None, keep_initial_representation=True):
"""
See class definition for full documentation.
See the class definition for full documentation.

EXAMPLES::

Expand Down Expand Up @@ -1285,9 +1285,9 @@ cdef class LinearMatroid(BasisExchangeMatroid):

.. WARNING::

This method is linked to __richcmp__ (in Cython) and __cmp__ or
__eq__/__ne__ (in Python). If you override one, you should (and in
Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!

EXAMPLES::

Expand Down Expand Up @@ -3078,7 +3078,7 @@ cdef class BinaryMatroid(LinearMatroid):
"""
def __init__(self, matrix=None, groundset=None, reduced_matrix=None, ring=None, keep_initial_representation=True, basis=None):
"""
See class definition for full documentation.
See the class definition for full documentation.

.. NOTE::

Expand Down Expand Up @@ -4111,7 +4111,7 @@ cdef class TernaryMatroid(LinearMatroid):
"""
def __init__(self, matrix=None, groundset=None, reduced_matrix=None, ring=None, keep_initial_representation=True, basis=None):
"""
See class definition for full documentation.
See the class definition for full documentation.

.. NOTE::

Expand Down Expand Up @@ -4989,7 +4989,7 @@ cdef class QuaternaryMatroid(LinearMatroid):
"""
def __init__(self, matrix=None, groundset=None, reduced_matrix=None, ring=None, keep_initial_representation=True, basis=None):
"""
See class definition for full documentation.
See the class definition for full documentation.

.. NOTE::

Expand Down Expand Up @@ -5694,7 +5694,7 @@ cdef class RegularMatroid(LinearMatroid):
"""
def __init__(self, matrix=None, groundset=None, reduced_matrix=None, ring=None, keep_initial_representation=True):
"""
See class definition for full documentation.
See the class definition for full documentation.

.. NOTE::

Expand Down
6 changes: 3 additions & 3 deletions src/sage/matroids/matroid.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -3944,9 +3944,9 @@ cdef class Matroid(SageObject):

.. WARNING::

This method is linked to ``__richcmp__`` (in Cython) and
``__cmp__`` or ``__eq__``/``__ne__`` (in Python). If you override
one, you should (and in Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!

EXAMPLES::

Expand Down
8 changes: 4 additions & 4 deletions src/sage/matroids/minor_matroid.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ class wraps around any matroid to provide an abstract minor. It

def __init__(self, matroid, contractions=None, deletions=None):
"""
See class docstring for documentation.
See the class docstring for documentation.
EXAMPLES::
Expand Down Expand Up @@ -372,9 +372,9 @@ def __hash__(self):
.. WARNING::
This method is linked to __richcmp__ (in Cython) and __cmp__ or
__eq__/__ne__ (in Python). If you override one, you should (and in
Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!
EXAMPLES::
Expand Down
6 changes: 3 additions & 3 deletions src/sage/matroids/rank_matroid.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,9 @@ def __hash__(self):

.. WARNING::

This method is linked to __richcmp__ (in Cython) and __cmp__ or
__eq__/__ne__ (in Python). If you override one, you should (and in
Cython: MUST) override the other!
This method is linked to ``__richcmp__`` (in Cython) and ``__cmp__``
or ``__eq__``/``__ne__`` (in Python). If you override one, you
should (and, in Cython, \emph{must}) override the other!

EXAMPLES::

Expand Down
6 changes: 2 additions & 4 deletions src/sage/matroids/transversal_matroid.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Transversal matroids

A transversal matroid arises from a groundset `E` and a collection `A` of sets
over the groundset. This can be modeled as a bipartite graph `B`, where the
vertices the left are groundset elements, the vertices on the right are the
vertices on the left are groundset elements, the vertices on the right are the
sets, and edges represent containment. Then a set `X` from the groundset is
independent if and only if `X` has a matching in `B`.

Expand Down Expand Up @@ -100,7 +100,7 @@ cdef class TransversalMatroid(BasisExchangeMatroid):

def __init__(self, sets, groundset=None, set_labels=None, matching=None):
"""
See class definition for full documentation.
See the class definition for full documentation.

EXAMPLES::

Expand Down Expand Up @@ -850,8 +850,6 @@ cdef class TransversalMatroid(BasisExchangeMatroid):
parameter. This checks that the matching provided is indeed a matching, fits in
the set system, and is maximal.

OUTPUT: boolean

EXAMPLES::

sage: from sage.matroids.transversal_matroid import *
Expand Down
Loading

0 comments on commit 61f6748

Please sign in to comment.