![]() ![]() python/lsst/meas/algorithms/measurement.py.python/lsst/meas/photocal/PhotoCal.py ( in meas_astrom).How to write your own command line task, including how-to-retarget sub-tasks please do it this way for now.ĭipoleMeasurementTask(SourceMeasurementTask) I don't claim that these are the best way to achieve the goal, but let's get the docs written and the haggle over how we should have done it - i.e. ![]() ![]() python/lsst/meas/algorithms/detection.py ( SourceDetectionTask) python/lsst/meas/algorithms/measurement.py ( SourceMeasurementTask) There are example docs in python source code in: Think about your users, which includes you! Please try to make these examples as helpful as possible. Examples may not assume the use of the cmdLineTask to build sensorRefs as that can't be used by generic user python scripts. If important information is provided by the config, then the user should be told how to build that config in their code if the arguments are a blob of some sort the example must tell the user how to build it. I'm mostly concerned about constructor arguments and the case that the inputs include a blob, in which case I want the docs to include how that blob should be built in the calling code - not from the pipe_base argument parser. asure), but there's no need to fix this now. Also, some tasks don't have a run method (e.g. However, if your task *does* use a blob then the documentation must list all of its members, both optional and required (and enough information for the user to decide which is which for their application). As most of you know, I am unhappy about using blobs/kwargs/sensorRefs as inputs to Tasks, but this mail is not a request to fix this. The input description may not just be something like "sensorRef of the needed inputs". Debugging options enabled with "import debug".Please check that your documentation appears the way that you expected. Task documentation will appear at as you check it in (and as soon as buildbot notices). Russell points out that you have to write \_\_init\_\_ I use \copydoc to get the method docs into the "right place".""" comments are fully processed by doxygen If you feel the need to clean things up you may do it as part of the documentation, but as a short-lived branch. It is acceptable to make documentation only changes on master. # \addtogroup LSST_task_documentation # \ py file, adding an entry to the doxygen group LSST_Task_Documentation group, e.g. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |