# Request for example debug.py enumerating all of the debug options.

XMLWordPrintable

#### Details

• Type: Improvement
• Status: To Do
• Resolution: Unresolved
• Fix Version/s: None
• Component/s:
• Labels:

#### Description

Would it be possible to provide an example debug.py file with all of the potential options for debugging given (and set to False).

I'm of course new and an outsider to main DM developement, but as an example it took me an hour to figure out that I needed to pass a dict instead of just saying True for setting display for lsst.pipe.tasks.astrometry.

 lsstDebug.Info("lsst.pipe.tasks.astrometry").display = {'astrometry': True} 

#### Attachments

1. debug.py
8 kB

#### Activity

Hide
John Swinbank added a comment -

Show
Hide
Robert Lupton added a comment -

Is there a top-level page where all the tasks on pipelines.lsst.io are listed?  It wouldn't be obvious to me to look under lsst.meas.astrom for Task documentation, unless I remembered the twisted history of which task was written when.

Show
Robert Lupton added a comment - Is there a top-level page where all the tasks on pipelines.lsst.io are listed?  It wouldn't be obvious to me to look under lsst.meas.astrom for Task documentation, unless I remembered the twisted history of which task was written when.
Hide
John Swinbank added a comment - - edited

I don't know of one, but that may be just a matter of my ignorance. I think it would be easy to create one by adding a page containing something like:

 .. lsst-tasks::  :root: lsst 

We should probably check with Jonathan Sick to make sure a) that such a page doesn't already exist, and b) that my idea is not crazy, before doing so, though.

Show
John Swinbank added a comment - - edited I don't know of one, but that may be just a matter of my ignorance. I think it would be easy to create one by adding a page containing something like: .. lsst-tasks:: :root: lsst We should probably check with Jonathan Sick to make sure a) that such a page doesn't already exist, and b) that my idea is not crazy, before doing so, though.
Hide
Jonathan Sick added a comment -

Is there a top-level page where all the tasks on pipelines.lsst.io are listed? It wouldn't be obvious to me to look under lsst.meas.astrom for Task documentation, unless I remembered the twisted history of which task was written when.

Yes, the original plan calls for curating the task listings around processing contexts (https://dmtn-030.lsst.io/#processing-section). Having an uncurated index page to all tasks, though, sounds pretty useful. John Swinbank's suggestion should work for that. That's a different ticket, than this one, though, right? I've created DM-20850 to go ahead and implement that.

It's really unfortunate that task documentation is now split across two locations.

You can improve this by directing more resources to writing task documentation We're all in this together; documentation doesn't just happen.

Also, when I wrote up the port of the task documentation to Sphinx I was directed by Frossie Economou not to spend a lot of time on lsstDebug-related docs because it seems a risk of imminent deprecation (reiterated in https://dmtn-085.lsst.io), so not worth the effort. That's why the template speaks so briefly about debug variables. You might want to move quickly on deciding what to do about lsstDebug so we know definitely whether to put effort into it or not.

Show
Hide
Michael Wood-Vasey [X] (Inactive) added a comment -

A combination of the example debug.py attached to this ticket (in 2015!) with a link to the page Robert Lupton pointed out documenting (almost) all of the Tasks and their debugs is what I would have wanted when I filed this ticket and still is useful today. The Doxygen tree seems like a reasonable place for the list of all Tasks and their debug variables to live, but something like pipelines.lsst.io seems a more obvious place for the example debug.py.

Show
Michael Wood-Vasey [X] (Inactive) added a comment - A combination of the example debug.py attached to this ticket (in 2015!) with a link to the page Robert Lupton pointed out documenting (almost) all of the Tasks and their debugs is what I would have wanted when I filed this ticket and still is useful today. The Doxygen tree seems like a reasonable place for the list of all Tasks and their debug variables to live, but something like pipelines.lsst.io seems a more obvious place for the example debug.py .

#### People

Assignee:
Unassigned
Reporter:
Michael Wood-Vasey [X] (Inactive)
Watchers:
John Swinbank, Jonathan Sick, Michael Wood-Vasey [X] (Inactive), Robert Lupton, Tim Jenness
0 Vote for this issue
Watchers:
5 Start watching this issue

#### Dates

Created:
Updated:

#### Jenkins

No builds found.