Status: To Do
Fix Version/s: None
Component/s: pipe_base, Stack Documentation and UX
The documentation at https://pipelines.lsst.io/v/DM-11253/modules/lsst.pipe.base/command-line-task-argument-reference.html does not make it clear how Tasks, and Command-Line Tasks in particular, handle errors. The documentation for --noExit says that the caller is responsible for error-handling if that flag is used, but does not say how it can do so (presumably there's a failure flag in the returned object somewhere?). Also, it is not clear how --doRaise and --noExit interact with each other (nor any mention of them being mutually exclusive).
Please clarify these points in the documentation.
It says the status code is always the number of failed dataIds. Is there some other meaning?
I'm unassigning myself as it's out-of-scope with what SQuaRE can do. Hopefully, it can get re-triaged into a DP/AP/middleware team.
Good point. On one hand, I should also document the meaning of shell status codes (what typical command-line task users will see) and also document the Python-API level error handling. The latter could go well with re-vamping docs for how to make a task and command-line task;