Skip to content

Commit 3607d42

Browse files
authored
Fix docstring formatting in similar_matrices.py
Corrected formatting and punctuation in docstring.
1 parent 840e5c7 commit 3607d42

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

‎matrix/similar_matrices.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
This implementation relies on SymPy to compute the Jordan canonical form of
66
both matrices. Two matrices are similar precisely when their Jordan forms are
77
equal up to permutation of the Jordan blocks.
8+
* https://en.wikipedia.org/wiki/Jordan_matrix
9+
* https://en.wikipedia.org/wiki/Jordan_normal_form
810
911
Examples
1012
--------
@@ -109,7 +111,7 @@ def are_similar_matrices(
109111
matrix_a, matrix_b:
110112
Square matrices represented as nested sequences (or SymPy matrices).
111113
simplify_entries:
112-
If ``True`` (default) the function attempts to simplify each entry so
114+
If ``True`` (default), the function attempts to simplify each entry so
113115
that values that are algebraically equal are treated as such. Set this
114116
to ``False`` to skip simplification when working with symbolic inputs
115117
that should remain untouched.

0 commit comments

Comments
 (0)