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
-
- Done
-
- Done
-
- Won't Fix
-
- Won't Fix
-
- Won't Fix
-
- Invalid
-
DM-6075 Document the need for abstract base tasks for tasks
- Done
- mentioned in
-
Page Loading...
Activity
| Assignee | Jonathan Sick [ jsick ] |
| Description |
Our current documentation on writing tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5].
Please provide a unified reference document on task construction, explicitly specifying all requirements. |
Our current documentation on writing tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5]).
Please provide a unified reference document on task construction, explicitly specifying all requirements. |
| Assignee | Jonathan Sick [ jsick ] |
| Epic Link |
|
| Description |
Our current documentation on writing tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5]).
Please provide a unified reference document on task construction, explicitly specifying all requirements. |
Our current documentation on writing tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5]).
Please provide a unified reference document on task construction, explicitly specifying all requirements. |
| Description |
Our current documentation on writing tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5]).
Please provide a unified reference document on task construction, explicitly specifying all requirements. |
Our current documentation on writing Tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5]).
Please provide a unified reference document on task construction, explicitly specifying all requirements. |
| Summary | Refresh and update documentation on writing Tasks | Refresh & unify documentation on writing Tasks |
| Labels | pipelines-docs |
| Remote Link | This issue links to "Page (Confluence)" [ 28631 ] |
| Resolution | Done [ 10000 ] | |
| Status | To Do [ 10001 ] | Won't Fix [ 10405 ] |