Improve documentation for InvalidHMM in TraceAligner

althonos · Oct 21, 2023 · b25f214 · b25f214
1 parent 81daebd
commit b25f214
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/docs/api/errors.rst b/docs/api/errors.rst
@@ -59,4 +59,12 @@ InvalidParameter
 
 .. autoexception:: InvalidParameter(ValueError)
    :special-members: __init__
-   :members:
+   :members:
+
+
+InvalidHMM
+----------
+
+.. autoexception:: InvalidHMM(ValueError)
+   :special-members: __init__
+   :members:
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -226,3 +226,7 @@ API Reference
        pyhmmer.errors.UnexpectedError
        pyhmmer.errors.EaselError
        pyhmmer.errors.AlphabetMismatch
+       pyhmmer.errors.ServerError
+       pyhmmer.errors.MissingCutoffs
+       pyhmmer.errors.InvalidParameter
+       pyhmmer.errors.InvalidHMM
diff --git a/pyhmmer/plan7.pyx b/pyhmmer/plan7.pyx
@@ -8752,6 +8752,8 @@ cdef class TraceAligner:
         Raises:
             `~pyhmmer.errors.AlphabetMismatch`: when the alphabet of any
                 of the sequences does not correspond to the HMM alphabet.
+            `~pyhmmer.errors.InvalidHMM`: when given a HMM that is not
+                valid.
 
         .. versionchanged:: 0.7.0
             Targets must now be inside a `~pyhmmer.easel.DigitalSequenceBlock`.
@@ -8839,6 +8841,8 @@ cdef class TraceAligner:
         Raises:
             `~pyhmmer.errors.AlphabetMismatch`: when the alphabet of any
                 of the sequences does not correspond to the HMM alphabet.
+            `~pyhmmer.errors.InvalidHMM`: when given a HMM that is not
+                valid.
 
         .. versionchanged:: 0.7.0
             Targets must now be inside a `~pyhmmer.easel.DigitalSequenceBlock`.