[issue21252] Lib/asyncio/events.py has tons of docstrings which are just XXX
Roundup Robot added the comment: New changeset d1712437cab2 by Victor Stinner in branch '3.4': Tulip issue 83, Python issue #21252: Fill some XXX docstrings in asyncio http://hg.python.org/cpython/rev/d1712437cab2 New changeset 782c3b4cbc88 by Victor Stinner in branch 'default': (Merge 3.4) Tulip issue 83, Python issue #21252: Fill some XXX docstrings in asyncio http://hg.python.org/cpython/rev/782c3b4cbc88 -- nosy: +python-dev ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue21252 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue21252] Lib/asyncio/events.py has tons of docstrings which are just XXX
STINNER Victor added the comment: Fixed. See also the Tulip issue https://code.google.com/p/tulip/issues/detail?id=83 -- resolution: - fixed status: open - closed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue21252 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue21252] Lib/asyncio/events.py has tons of docstrings which are just XXX
STINNER Victor added the comment: A first patch to fill remaining XXX docstring of events.py. -- keywords: +patch Added file: http://bugs.python.org/file35391/asyncio_events_docstring.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue21252 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue21252] Lib/asyncio/events.py has tons of docstrings which are just XXX
STINNER Victor added the comment: Updated patch to address Guido's remarks. FYI I copied the documentation from the Doc repository and Lib/asyncio/unix_events.py (for child watchers), and so I copied typos :-) I tried to fix all copies of the documentation in my new patch. I didn't mention the API of a child watcher because the class is not documented yet... nor get_child_watcher and set_child_watcher functions! (I mean not documented in the Doc/ directory). I suggest to open a new issue to enhance the documentation of this part of the part. -- Added file: http://bugs.python.org/file35393/asyncio_events_docstring-2.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue21252 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue21252] Lib/asyncio/events.py has tons of docstrings which are just XXX
New submission from Alex Gaynor: It would be nice if these said something useful. (http://hg.python.org/cpython/file/default/Lib/asyncio/events.py) -- components: Library (Lib) messages: 216478 nosy: alex priority: normal severity: normal status: open title: Lib/asyncio/events.py has tons of docstrings which are just XXX versions: Python 3.4, Python 3.5 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue21252 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue21252] Lib/asyncio/events.py has tons of docstrings which are just XXX
Yury Selivanov added the comment: I had plans to copy some documentation from python docs to asyncio docstrings. I'll try to do this sometime this week. Thanks for reminding us about the issue! -- assignee: - yselivanov nosy: +gvanrossum, haypo, yselivanov ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue21252 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue21252] Lib/asyncio/events.py has tons of docstrings which are just XXX
Guido van Rossum added the comment: My bad. But I think docstrings should NOT be just copies of the separate docs. On Apr 16, 2014 9:01 AM, Yury Selivanov rep...@bugs.python.org wrote: Yury Selivanov added the comment: I had plans to copy some documentation from python docs to asyncio docstrings. I'll try to do this sometime this week. Thanks for reminding us about the issue! -- assignee: - yselivanov nosy: +gvanrossum, haypo, yselivanov ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue21252 ___ -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue21252 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue21252] Lib/asyncio/events.py has tons of docstrings which are just XXX
Yury Selivanov added the comment: My bad. But I think docstrings should NOT be just copies of the separate docs. I agree. I didn't want to blindly copy them, but rather use existing documentation as guidance baseline. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue21252 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
