API Docs: Use raises field list syntax

See 
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists
This commit is contained in:
2020-09-29 15:05:45 -04:00
parent ebf752625e
commit 4c3047a9cd
3 changed files with 13 additions and 18 deletions

View File

@@ -1687,7 +1687,7 @@ PyDoc_STRVAR(
"\n"
" Set the matrix to its adjugate.\n"
"\n"
" .. note:: When the matrix cannot be adjugated a :exc:`ValueError` exception is raised.\n"
" :raises ValueError: if the matrix cannot be adjugate.\n"
"\n"
" .. seealso:: `Adjugate matrix <https://en.wikipedia.org/wiki/Adjugate_matrix>`__ on "
"Wikipedia.\n");
@@ -1726,8 +1726,7 @@ PyDoc_STRVAR(
"\n"
" :return: the adjugated matrix.\n"
" :rtype: :class:`Matrix`\n"
"\n"
" .. note:: When the matrix cant be adjugated a :exc:`ValueError` exception is raised.\n");
" :raises ValueError: if the matrix cannot be adjugated\n");
static PyObject *Matrix_adjugated(MatrixObject *self)
{
return matrix__apply_to_copy(Matrix_adjugate, self);