From bdf3aeee5d2c5bbd521d236c702f7fba4b969a2d Mon Sep 17 00:00:00 2001 From: Krzysztof Findeisen Date: Tue, 27 Aug 2024 11:10:59 -0700 Subject: [PATCH] Clarify usage pattern of AnnotatedPartialOutputsError. 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. --- python/lsst/pipe/base/_status.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/python/lsst/pipe/base/_status.py b/python/lsst/pipe/base/_status.py index 0d2f754f..b517cc1e 100644 --- a/python/lsst/pipe/base/_status.py +++ b/python/lsst/pipe/base/_status.py @@ -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