Skip to content

Commit

Permalink
Docstring edits
Browse files Browse the repository at this point in the history
Work in `logic` and `manifolds`.
  • Loading branch information
gmou3 committed Jun 18, 2024
1 parent 629d9c2 commit 60fc897
Show file tree
Hide file tree
Showing 86 changed files with 703 additions and 2,347 deletions.
2 changes: 1 addition & 1 deletion src/sage/algebras/fusion_rings/fusion_ring.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ class FusionRing(WeylCharacterRing):
- ``conjugate`` -- (default: ``False``) set ``True`` to obtain
the complex conjugate ring
- ``cyclotomic_order`` -- (default: computed depending on ``ct`` and ``k``)
- ``fusion_labels`` -- (default: ``None``) either a tuple of strings to use as labels of the
- ``fusion_labels`` -- (default: ``None``) either a tuple of strings to use as labels of the
basis of simple objects, or a string from which the labels will be
constructed
- ``inject_variables`` -- (default: ``False``): use with ``fusion_labels``.
Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/finite_state_machine.py
Original file line number Diff line number Diff line change
Expand Up @@ -1564,7 +1564,7 @@ def is_final(self):
@is_final.setter
def is_final(self, is_final):
"""
Defines the state as a final state or a non-final state.
Define the state as a final state or a non-final state.

INPUT:

Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/root_system/reflection_group_element.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ cdef class ComplexReflectionGroupElement(PermutationGroupElement):

cpdef _act_on_(self, vec, bint self_on_left):
r"""
Defines the action of ``self`` as a linear transformation
Define the action of ``self`` as a linear transformation
on the vector space, in the basis given by the simple
roots.
Expand Down
2 changes: 1 addition & 1 deletion src/sage/dynamics/arithmetic_dynamics/projective_ds.py
Original file line number Diff line number Diff line change
Expand Up @@ -2866,7 +2866,7 @@ def possible_periods(self, **kwds):
kwds:
- ``prime_bound`` -- (default: ``[1, 20]``) a list or tuple of
- ``prime_bound`` -- (default: ``[1, 20]``) a list or tuple of
two positive integers or an integer for the upper bound
- ``bad_primes`` -- (optional) a list or tuple of integer primes,
Expand Down
2 changes: 1 addition & 1 deletion src/sage/dynamics/arithmetic_dynamics/wehlerK3.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@

def WehlerK3Surface(polys):
r"""
Defines a K3 Surface over `\mathbb{P}^2 \times \mathbb{P}^2` defined as
Define a K3 Surface over `\mathbb{P}^2 \times \mathbb{P}^2` defined as
the intersection of a bilinear and biquadratic form. [Weh1998]_
INPUT: Bilinear and biquadratic polynomials as a tuple or list
Expand Down
13 changes: 7 additions & 6 deletions src/sage/graphs/generic_graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -546,9 +546,10 @@ def __eq__(self, other):
``G == H``.

Two graphs are considered equal if the following hold:
- they are either both directed, or both undirected;
- they have the same settings for loops, multiedges, and weightedness;
- they have the same set of vertices;

- they are either both directed, or both undirected
- they have the same settings for loops, multiedges, and weightedness
- they have the same set of vertices
- they have the same (multi)set of arrows/edges, where labels of
arrows/edges are taken into account if *and only if* the graphs are
considered weighted. See :meth:`~GenericGraph.weighted`.
Expand Down Expand Up @@ -11131,15 +11132,15 @@ def pagerank(self, alpha=0.85, personalization=None, by_weight=False,

- ``algorithm`` -- string (default: ``None``); the algorithm to use in
computing PageRank of ``G``. The following algorithms are
supported:
supported:

- ``NetworkX`` -- uses NetworkX's default implementation (Scipy as of 2.6)
- ``'NetworkX'`` -- uses NetworkX's default implementation (Scipy as of 2.6)

- ``'Scipy'`` -- uses Scipy's PageRank algorithm implementation

- ``'igraph'`` -- uses igraph's PageRank algorithm implementation

- ``"None"`` -- uses best implementation available
- ``None`` -- uses best implementation available

OUTPUT: a dictionary containing the PageRank value of each node

Expand Down
4 changes: 2 additions & 2 deletions src/sage/graphs/graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -581,8 +581,8 @@ class Graph(GenericGraph):
- ``convert_empty_dict_labels_to_None`` -- this arguments sets the default
edge labels used by NetworkX (empty dictionaries) to be replaced by
``None``, the default Sage edge label. It is set to ``True`` iff a
NetworkX graph is on the input.
``None``, the default Sage edge label. It is set to ``True`` iff a
NetworkX graph is on the input.
EXAMPLES:
Expand Down
2 changes: 1 addition & 1 deletion src/sage/interfaces/gap3.py
Original file line number Diff line number Diff line change
Expand Up @@ -858,7 +858,7 @@ def __getattr__(self, attrname):

def _tab_completion(self):
r"""
Defines the list of methods and attributes that will appear for tab
Define the list of methods and attributes that will appear for tab
completion.
OUTPUT:
Expand Down
18 changes: 9 additions & 9 deletions src/sage/interfaces/magma.py
Original file line number Diff line number Diff line change
Expand Up @@ -1429,7 +1429,7 @@ def _tab_completion(self, verbose=True, use_disk_cache=True):
- ``verbose`` -- boolean (default: ``True``); whether to
verbosely output status info the first time the command list is
built
built
- ``use_disk_cache`` -- boolean (default: ``True``); use
cached command list, which is saved to disk
Expand Down Expand Up @@ -2311,22 +2311,22 @@ def _latex_(self):
Types that are nicely latexed include:
- rationals
- rationals
- matrices
- matrices
- polynomials
- polynomials
- binary quadratic forms
- binary quadratic forms
- elements of quadratic, cyclotomic number fields, and general
- elements of quadratic, cyclotomic number fields, and general
number fields
- points
- points
- elliptic curves
- elliptic curves
- power series
- power series
IMPLEMENTATION: Calls latex.m, which is in
SAGE_EXTCODE/magma/latex.m
Expand Down
4 changes: 2 additions & 2 deletions src/sage/interfaces/maxima_abstract.py
Original file line number Diff line number Diff line change
Expand Up @@ -785,7 +785,7 @@ def plot3d_parametric(self, r, vars, urange, vrange, options=None):
- ``x``, ``y``, ``z`` -- string representing a function (such
as ``x="u2+v2"``, ...) vars is a list or two strings
representing variables (such as vars = ["u","v"])
representing variables (such as vars = ["u","v"])
- ``urange`` -- [umin, umax]
Expand Down Expand Up @@ -886,7 +886,7 @@ def de_solve_laplace(self, de, vars, ics=None):
- ``ics`` -- list of numbers representing initial
conditions, with symbols allowed which are represented by strings
(eg, f(0)=1, f'(0)=2 is ics = [0,1,2])
(eg, f(0)=1, f'(0)=2 is ics = [0,1,2])
EXAMPLES::
Expand Down
12 changes: 6 additions & 6 deletions src/sage/logic/booleval.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ def eval_formula(tree, vdict):
INPUT:
- ``tree`` -- a list of three elements corresponding to a branch of a
- ``tree`` -- list of three elements corresponding to a branch of a
parse tree
- ``vdict`` -- a dictionary containing variable keys and boolean values
- ``vdict`` -- dictionary containing variable keys and boolean values
OUTPUT: the result of the evaluation as a boolean value
Expand Down Expand Up @@ -79,7 +79,7 @@ def eval_f(tree):
INPUT:
- ``tree`` -- a list of three elements corresponding to a branch of a
- ``tree`` -- list of three elements corresponding to a branch of a
parse tree
OUTPUT: the result of the evaluation as a boolean value
Expand Down Expand Up @@ -107,11 +107,11 @@ def eval_op(op, lv, rv):
INPUT:
- ``op`` -- a string or character representing a boolean operator
- ``op`` -- string or character representing a boolean operator
- ``lv`` -- a boolean or variable
- ``lv`` -- boolean or variable
- ``rv`` -- a boolean or variable
- ``rv`` -- boolean or variable
OUTPUT: the evaluation of ``lv op rv`` as a boolean value
Expand Down
Loading

3 comments on commit 60fc897

@kwankyu
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise lgtm.

@gmou3
Copy link
Contributor Author

@gmou3 gmou3 commented on 60fc897 Jun 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

otherwise?

@kwankyu
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No comment? Then "otherwise" means "all".

Please sign in to comment.