[docs] [issue24878] Add docstrings to selected named tuples

Raymond Hettinger report at bugs.python.org
Mon Aug 17 06:32:47 CEST 2015


Raymond Hettinger added the comment:

For example:

>>> import sched
>>> help(sched.Event)

class Event(Event)
 |  Event(time, priority, action, argument, kwargs)
 | 
...
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from Event:
 |  
 |  action
 |      Executing the event means executing
 |      action(*argument, **kwargs)
 |  
 |  argument
 |      argument is a sequence holding the positional
 |      arguments for the action.
 |  
 |  kwargs
 |      kwargs is a dictionary holding the keyword
 |      arguments for the action.
 |  
 |  priority
 |      Events scheduled for the same time will be executed
 |      in the order of their priority.
 |  
 |  time
 |      Numeric type compatible with the return value of the
 |      timefunc function passed to the constructor.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue24878>
_______________________________________


More information about the docs mailing list