Status: Won't Fix
Fix Version/s: None
Component/s: pipe_base, Stack Documentation and UX
DM-11253 ported docs on how to create a task from Doxygen to reStructuredText. This generated a number of comments in the PR https://github.com/lsst/pipe_base/pull/37
In this ticket:
- Address those PR comments
- Generally improve the topic (refactor into topic-based writing, for example).
|Field||Original Value||New Value|
|Epic Link||DM-5646 [ 23496 ]|
Kian-Tat Lim made changes -
|Resolution||Done [ 10000 ]|
|Status||To Do [ 10001 ]||Won't Fix [ 10405 ]|
Something I noted in passing: "Supply useful defaults for all config parameters if at all possible. Your task will be much easier to use if the default configuration usually suffices." should be enhanced with "If you can't think of a useful default for a config parameter, it is likely better off being an input parameter instead."