Fix issue #13449 related to matrices.py docStrings #13461
Conversation
added double backticks to showcase the variable names and function names inside the matrices.py
sympy/matrices/matrices.py
Outdated
| @@ -711,7 +711,7 @@ def cross_cancel(a, i, b, j): | |||
| return self._new(self.rows, self.cols, mat), tuple(pivot_cols), tuple(swaps) | |||
|
|
|||
| def echelon_form(self, iszerofunc=_iszero, simplify=False, with_pivots=False): | |||
| """Returns a matrix row-equivalent to `self` that is | |||
| """Returns a matrix row-equivalent to ```self``` that is | |||
There was a problem hiding this comment.
I'm guessing you don't want triple tics here. (?)
sympy/matrices/matrices.py
Outdated
| simplify : Function | ||
| A function used to simplify elements when looking for a pivot. | ||
| By default SymPy's `simplify`is used. | ||
| By default SymPy's ``simplify``is used. |
sympy/matrices/matrices.py
Outdated
| @@ -1133,10 +1133,10 @@ def eigenvals(self, error_when_incomplete=True, **flags): | |||
| return eigs | |||
|
|
|||
| def eigenvects(self, error_when_incomplete=True, **flags): | |||
| """Return list of triples (eigenval, multiplicity, basis). | |||
| """Return list of ``triples (eigenval, multiplicity, basis)``. | |||
There was a problem hiding this comment.
I'm not sure the tics should be around this. This could also be phrased, "Return a tuple containing (in order) the eigenvalue, multiplicity and basis.
sympy/matrices/matrices.py
Outdated
| @@ -1474,8 +1474,8 @@ def pick_vec(small_basis, big_basis): | |||
| def left_eigenvects(self, **flags): | |||
| """Returns left eigenvectors and eigenvalues. | |||
|
|
|||
| This function returns the list of triples (eigenval, multiplicity, | |||
| basis) for the left eigenvectors. Options are the same as for | |||
| This function returns the list of ``triples (eigenval, multiplicity, | |||
There was a problem hiding this comment.
same as above regarding tics and phrasing
|
I (almost) never read anything but the ASCII so don't understand the nuance between single and double bac tics, so I"m not sure if all these changes are needed/right. Someone with more back-tic-foo should have a look. |
|
Duplicates #13459 |
|
@smichr Thanks for your input. I have made changes accordingly. |
| an N x 1 vector whose entries are coefficients of the | ||
| polynomial | ||
|
|
||
| charpoly(M) = det(t*I - M) | ||
| ``charpoly(M) = det(t*I - M)`` |
There was a problem hiding this comment.
we don't need double backticks here. Rather some .. math .. would be good. See as an example https://github.com/sympy/sympy/blob/master/sympy/concrete/products.py#L31-L33.
| @@ -595,7 +595,7 @@ def _normalize_op_args(self, op, col, k, col1, col2, error_str="col"): | |||
|
|
|||
| def _permute_complexity_right(self, iszerofunc): | |||
| """Permute columns with complicated elements as | |||
| far right as they can go. Since the `sympy` row reduction | |||
| far right as they can go. Since the ``sympy`` row reduction | |||
There was a problem hiding this comment.
Change this to SymPy without any backticks, neither single nor double backticks.
|
|
||
| D = P^-1 * M * P | ||
| ``D = P^-1 * M * P`` |
There was a problem hiding this comment.
Don't use double backticks here. Use .. math:: ... here as has been described above for one of the changes.
| @@ -4286,8 +4286,8 @@ def _normalize_slices(row_slice, col_slice): | |||
| return (row_slice, col_slice) | |||
|
|
|||
| def _coord_to_index(i, j): | |||
| """Return the index in _mat corresponding | |||
| to the (i,j) position in the matrix. """ | |||
| """Return the index ``in _mat`` corresponding | |||
There was a problem hiding this comment.
should in be inside the double backticks?
| (pivot_offset, pivot_val, assumed_nonzero, newly_determined) | ||
| where pivot_offset is the index of the pivot, pivot_val is | ||
| the (possibly simplified) value of the pivot, assumed_nonzero | ||
| ``(pivot_offset, pivot_val, assumed_nonzero, newly_determined)`` |
| where pivot_offset is the index of the pivot, pivot_val is | ||
| the (possibly simplified) value of the pivot, assumed_nonzero | ||
| ``(pivot_offset, pivot_val, assumed_nonzero, newly_determined)`` | ||
| where ``pivot_offset`` is the index of the pivot, ``pivot_val`` is |
| the (possibly simplified) value of the pivot, assumed_nonzero | ||
| ``(pivot_offset, pivot_val, assumed_nonzero, newly_determined)`` | ||
| where ``pivot_offset`` is the index of the pivot, ``pivot_val`` is | ||
| the (possibly simplified) value of the pivot, ``assumed_nonzero`` |
| is True if an assumption that the pivot was non-zero | ||
| was made without being proved, and newly_determined are | ||
| was made without being proved, and ``newly_determined`` are |
gxyd
added
PR: author's turn
|
@smichr the double ticks are required to render as code in Sphinx/RST. A single backtick renders as LaTeX math. |
|
By the way, this makes me think about changing the behavior of single ticks #13519 |
|
Fixed in #15950. |
added double backticks to showcase the variable names and function names inside the matrices.py