You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee='https://github.com/briancurtin'closed_at=<Date2010-08-24.05:20:55.844>created_at=<Date2009-12-26.21:29:28.394>labels= ['type-bug', 'OS-windows', 'docs']
title='Patch to add docstrings to msvcrt'updated_at=<Date2010-08-24.05:20:55.842>user='https://github.com/briancurtin'
Committed r77126 in trunk.
I reflowed the text for getch(), so that help(msvcrt) displays nicely in a
80-chars-wide console (this was my "test")
I was about to merge it into py3k, when I realized that the documentation
should be updated to match the str/bytes distinction.
Can someone suggest a patch for py3k? (and for Doc/library/msvcrt.rst as
well)
Here is a patch for py3k. It uses the same contents as before but with
changes to the str/bytes wording on getch_doc, putch_doc, and
ungetch_doc. Includes updates to the msvcrt.rst file. Let me know if the
wording seems correct (or if I left anything out).
I went ahead and added docstrings to the debug-only functions as a bonus.
Activity
briancurtin commentedon Dec 26, 2009
Patch to provide docstrings throughout the msvcrt module.
amauryfa commentedon Dec 28, 2009
This is a good idea. I have some comments though:
characters.
ending ' \' should be replaced by with '\n\' (see Python/sysmodule.c, for
example)
briancurtin commentedon Dec 28, 2009
I fixed up the bodies of the docstrings, removed the weird quotes around
"pushed back" (copy/paste error), and got the heapmin/locking name fixed up.
Thanks for taking a look at this.
birkenfeld commentedon Dec 29, 2009
Patch looks good, can someone with the ability to test it please commit it?
amauryfa commentedon Dec 29, 2009
Committed r77126 in trunk.
I reflowed the text for getch(), so that help(msvcrt) displays nicely in a
80-chars-wide console (this was my "test")
I was about to merge it into py3k, when I realized that the documentation
should be updated to match the str/bytes distinction.
Can someone suggest a patch for py3k? (and for Doc/library/msvcrt.rst as
well)
briancurtin commentedon Dec 30, 2009
Here is a patch for py3k. It uses the same contents as before but with
changes to the str/bytes wording on getch_doc, putch_doc, and
ungetch_doc. Includes updates to the msvcrt.rst file. Let me know if the
wording seems correct (or if I left anything out).
I went ahead and added docstrings to the debug-only functions as a bonus.
briancurtin commentedon Aug 24, 2010
Committed to py3k in r84295.