Skip to content

Commit

Permalink
Clarify usage pattern of AnnotatedPartialOutputsError.
Browse files Browse the repository at this point in the history
This directs users to the annotate method for more details if the
documentation is built correctly, and serves as a backup to the method
docs if it's not.
  • Loading branch information
kfindeisen committed Aug 27, 2024
1 parent fe85a52 commit 4d1f932
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions python/lsst/pipe/base/_status.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,10 @@ class AnnotatedPartialOutputsError(RepeatableQuantumError):
written contain information about their own incompleteness or degraded
quality.
Clients should construct this exception by calling `annotate` instead of
calling the constructor directly. However, `annotate` does not chain the
exception; this must still be done by the client.
This exception should always chain the original error. When the
executor catches this exception, it will report the original exception. In
contrast, other exceptions raised from ``runQuantum`` are considered to
Expand Down

0 comments on commit 4d1f932

Please sign in to comment.