[issue7579] Patch to add docstrings to msvcrt

[Brian Curtin]

Brian Curtin  added the comment:

Committed to py3k in r84295.

--
resolution:  -> fixed
stage: patch review -> committed/rejected
status: open -> closed

___
Python tracker 

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

[issue7579] Patch to add docstrings to msvcrt

[Brian Curtin]

Changes by Brian Curtin :


--
assignee: d...@python -> brian.curtin

___
Python tracker 

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

[issue7579] Patch to add docstrings to msvcrt

[Mark Lawrence]

Changes by Mark Lawrence :


--
assignee: georg.brandl -> d...@python
nosy: +d...@python

___
Python tracker 

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

[issue7579] Patch to add docstrings to msvcrt

[Brian Curtin]

Changes by Brian Curtin :


--
priority:  -> normal
stage:  -> patch review
type:  -> behavior

___
Python tracker 

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

[issue7579] Patch to add docstrings to msvcrt

[Brian Curtin]

Brian Curtin  added the comment:

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.

--
Added file: http://bugs.python.org/file15704/issue7579_py3k.diff

___
Python tracker 

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

[issue7579] Patch to add docstrings to msvcrt

[Amaury Forgeot d'Arc]

Amaury Forgeot d'Arc  added the comment:

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)

--

___
Python tracker 

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

[issue7579] Patch to add docstrings to msvcrt

[Georg Brandl]

Georg Brandl  added the comment:

Patch looks good, can someone with the ability to test it please commit it?

--

___
Python tracker 

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

[issue7579] Patch to add docstrings to msvcrt

[Brian Curtin]

Brian Curtin  added the comment:

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.

--
Added file: http://bugs.python.org/file15684/msvcrt_docstrings_v2.diff

___
Python tracker 

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

[issue7579] Patch to add docstrings to msvcrt

[Amaury Forgeot d'Arc]

Amaury Forgeot d'Arc  added the comment:

This is a good idea. I have some comments though:
- the second docstring says "heapmin" when it should describe "locking".
- there are strange characters around "pushed back". Please use only ascii 
characters.
- The body of the docstrings should be split into separate lines. the 
ending ' \' should be replaced by with '\n\' (see Python/sysmodule.c, for 
example)

--
nosy: +amaury.forgeotdarc

___
Python tracker 

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

[issue7579] Patch to add docstrings to msvcrt

[Brian Curtin]

New submission from Brian Curtin :

Patch to provide docstrings throughout the msvcrt module.

--
assignee: georg.brandl
components: Documentation, Windows
files: msvcrt_docstrings.diff
keywords: patch
messages: 96893
nosy: brian.curtin, georg.brandl
severity: normal
status: open
title: Patch to add docstrings to msvcrt
versions: Python 2.7, Python 3.2
Added file: http://bugs.python.org/file15676/msvcrt_docstrings.diff

___
Python tracker 

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