Skip to content

Commit

Permalink
Clean up docs for optional return argument
Browse files Browse the repository at this point in the history
  • Loading branch information
mhostetter committed Nov 11, 2022
1 parent f8d63ac commit 61b8016
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/galois/_codes/_linear.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def decode(self, codeword, output="message", errors=False):
If `output="message"`, the error-corrected message as either a :math:`k`-length vector or :math:`(N, k)` matrix.
If `output="codeword"`, the error-corrected codeword as either a :math:`n`-length vector or :math:`(N, n)` matrix.
:
Optional return argument of the number of corrected symbol errors as either a scalar or :math:`N`-length array.
If `errors=True`, returns the number of corrected symbol errors as either a scalar or :math:`N`-length array.
Valid number of corrections are in :math:`[0, t]`. If a codeword has too many errors and cannot be corrected,
-1 will be returned.
Expand Down

0 comments on commit 61b8016

Please sign in to comment.