[issue24878] Add docstrings to selected named tuples

[Raymond Hettinger]

Raymond Hettinger added the comment:

Thanks Petr

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue24878
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24878] Add docstrings to selected named tuples

[Roundup Robot]

Roundup Robot added the comment:

New changeset 4432c441b639 by Raymond Hettinger in branch 'default':
Issue #24878: Fix typos and line wrap
https://hg.python.org/cpython/rev/4432c441b639

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue24878
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24878] Add docstrings to selected named tuples

[Petr Viktorin]

Petr Viktorin added the comment:

I see some typos in aifc.py:
+_aifc_params.sampwidth.__doc__ = 'Ample width in bytes'
+_aifc_params.compname.__doc__ = (A human-readable version ofcompression type

Should that be Sample width and of compression?

--
nosy: +encukou

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue24878
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24878] Add docstrings to selected named tuples

[Roundup Robot]

Roundup Robot added the comment:

New changeset 40f2bbb922e6 by Raymond Hettinger in branch 'default':
Issue #24878:  Add docstrings to selected namedtuples
https://hg.python.org/cpython/rev/40f2bbb922e6

--
nosy: +python-dev

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue24878
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24878] Add docstrings to selected named tuples

[Raymond Hettinger]

Changes by Raymond Hettinger raymond.hettin...@gmail.com:


--
resolution:  - fixed
stage: patch review - resolved
status: open - closed

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue24878
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24878] Add docstrings to selected named tuples

[Raymond Hettinger]

Changes by Raymond Hettinger raymond.hettin...@gmail.com:


Added file: http://bugs.python.org/file40197/ntdoc2.diff

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue24878
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24878] Add docstrings to selected named tuples

[Raymond Hettinger]

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 rep...@bugs.python.org
http://bugs.python.org/issue24878
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue24878] Add docstrings to selected named tuples

[Raymond Hettinger]

New submission from Raymond Hettinger:

Add docstrings to some named tuples that could benefit from it (there was more 
documentation or useful information other than just the field name).  This 
makes the help() on those named tuples much more informative.

--
assignee: docs@python
components: Documentation
files: ntdoc.diff
keywords: patch
messages: 248712
nosy: docs@python, rhettinger
priority: low
severity: normal
stage: patch review
status: open
title: Add docstrings to selected named tuples
versions: Python 3.6
Added file: http://bugs.python.org/file40193/ntdoc.diff

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue24878
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com