Skeleton step should provide helpful comments

Bug #1232900 reported by Glenn Ramsey
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MAPClient
Fix Committed
Medium
Unassigned

Bug Description

The skeleton step should have comments with a brief explanation of what is required and a link to the full documentation.
https://map-client.readthedocs.org/en/latest/MAP-create-plugin.html#plugin-interface

E.g.

def configure(self):
    # call the following if successful
    #self._configured = True
    #self._configureObserver()
    pass

#def execute(self):
# # The step must call this when done
# self._doneExecution()

Hugh Sorby (h-sorby)
Changed in mapclient:
milestone: none → 0.9.1
Hugh Sorby (h-sorby)
Changed in mapclient:
milestone: 0.9.1 → none
Revision history for this message
Hugh Sorby (h-sorby) wrote :

Will add comments in generated plugins created through the upcoming wizard. See bug #1231161 as it is related to this one.

Changed in mapclient:
milestone: none → 0.10.0
importance: Undecided → Medium
status: New → In Progress
Hugh Sorby (h-sorby)
Changed in mapclient:
status: In Progress → Fix Committed
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.