Details
-
Type:
Story
-
Status: Won't Fix
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:
-
Epic Link:
-
Team:SQuaRE
Description
Our current documentation on writing Tasks is fragmentary: it's partially in Doxygen and partially on Confluence. It's also incomplete – or, at least, it doesn't fully and unambiguously specify all the rules, procedures and best practices which developers are expected to bear in mind (see, for example, this discussion).
Please provide a unified reference document on task construction, explicitly specifying all requirements.
Attachments
Issue Links
- relates to
-
DM-2639 Standardize primary method names, run/runDataRef, across PipeTasks
- Done
-
DM-6640 IsrTask is not a valid CmdLineTask
- Done
-
DM-6877 Please document the appropriate location for tasks
- Won't Fix
-
DM-11673 Improve docs for creating Tasks (lsst.pipe.base docs)
- Won't Fix
-
DM-11674 Improve docs for creating command-line tasks (lsst.pipe.base docs)
- Won't Fix
-
DM-5067 Port ‘How to document a task’ from DM Confluence
- Invalid
-
DM-6075 Document the need for abstract base tasks for tasks
- Done
- mentioned in
-
Page Loading...
John Swinbank This is well-known and is already being internally planned in the
DM-6199epic, though tickets have not been filled in for it. Thank you for creating the ticket for us. Feel free to add other tickets to that epic in areas you see particular need.cc Frossie Economou