Condense doc for is_square into single docstring #2186
Conversation
|
Bother! I meant to choose draft PR. Oh well... |
|
Just click on "Convert to draft"... |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2186 +/- ##
=======================================
Coverage 87.95% 87.95%
=======================================
Files 127 127
Lines 31791 31791
=======================================
+ Hits 27961 27962 +1
+ Misses 3830 3829 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| @doc raw""" | ||
| is_square(a::T) where {T <: NCRingElement} | ||
| is_square(M::MatElem) | ||
| is_square(M::MatRingElem) | ||
| There are two distinct situations: | ||
| (1) if the argument is matrix then check whether the matrix **shape** is square | ||
| (2) if the argument is not a matrix then check whether the **value** is a square (in the same ring) | ||
| """ | ||
| function is_square end |
There was a problem hiding this comment.
IMHO this really should be two docstrings:
- one for
is_square(a::NCRingElement) - one for
is_square(M::MatElem)
Both then can be included in different parts of the manual (one in the ring interface section, one in matrix interface section).
2 participants
i thought I had already made this into a draft PR