Details
-
Type:
RFC
-
Status: Implemented
-
Resolution: Done
-
Component/s: DM
-
Labels:None
Description
This is a suggestion to remove these particular examples (which reside in $IP_ISR_DIR/examples and $PIPE_TASKS_DIR/examples, respectively) from the current Stack distribution, because they don't work in it properly (as documented in DM-9197 and DM-9142), and this amounts to a bit of 'false advertising' to anyone who might try to run them.
They do work on old tags of the pkgs they are in, and of course long-term we do want working examples for these Tasks, but as all the documentation is currently in transition, and fixing the current examples would take some work which may not be the best use of developers' time currently, it seems the easiest thing to do would be just to remove these.
(There are other advertised examples that also don't work, but these 2 might be some of the earliest a user may come across, and are the ones I've been most recently testing, so I'm just flagging these up in particular for now.)
[Also, this is the first time I'm filing an RFC, as suggested to do so for this by John Swinbank, so I hope I have the outlines of this basically right..]
Attachments
Issue Links
- is triggering
-
DM-9520 Remove calibrateTask.py example from Stack (for now)
- Done
-
DM-9521 Remove runIsrTask.py example from Stack (for now)
- Done
- relates to
-
DM-9142 calibrateTask.py example not working on current stack
- Won't Fix
-
DM-9389 Provide a working IsrTask example
- Won't Fix
-
DM-9390 Provide a working CalibrateTask & CharacterizeImageTask example
- Won't Fix
-
DM-9197 runIsrTask.py example (also) not working on current stack
- Invalid
Has this RFC been adopted?
DM-9389andDM-9390are the work that we would like to do later but they aren't the work triggered by this RFC.