search

dhellmann / google-highly-open-participation-psf

Automatically exported from code.google.com/p/google-highly-open-participation-psf
0 stars 0 forks source link

Add the missing docstrings of the new 'io' module. #173

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
Python 3000 provides a new I/O library module, called 'io', conforming
to PEP 3116. Document with docstrings the undocumented interfaces of
this module.

Completion:

Attach the results of a 'svn diff' (context diff) against the Python
3.0 source tree to this task in a comment, and send an e-mail briefly
describing the changes you made to the ghop-python mailing list.

Relevant pages:

 - PEP 3116 "New I/O", http://www.python.org/dev/peps/pep-3116/
 - http://svn.python.org/projects/python/branches/py3k/Lib/io.py
 - GettingAndCompilingPython
 - DocumentationAndExampleGuidelines
 - WorkingOnDocumentation

Task duration: please complete this task within 5 days (120 hours) of claiming 
it.

Original issue reported on code.google.com by the.good...@gmail.com on 7 Dec 2007 at 7:23

GoogleCodeExporter commented 9 years ago 
I claim this task.

Original comment by m.ottene...@gmail.com on 9 Dec 2007 at 10:36

GoogleCodeExporter commented 9 years ago

Original comment by georg.br...@gmail.com on 9 Dec 2007 at 10:41

GoogleCodeExporter commented 9 years ago 
Hello!
I re-read the task description several times though I'm not completely
sure what I am supposed to do.
Should I:

a) add docstrings to
http://svn.python.org/projects/python/branches/py3k/Lib/io.py . 'Cause
nearly all methods have already got one in there.
or
b) write a Documentation about the IO module to
http://docs.python.org/dev/3.0/library/index.html

Original comment by m.ottene...@gmail.com on 10 Dec 2007 at 7:52

GoogleCodeExporter commented 9 years ago 
BytesIO, BufferedWriter, BufferedRandom all look like they could use 
docstrings, but
other than that it looks good to me.  Wait for avassolotti to comment to be 
sure.

Original comment by the.good...@gmail.com on 10 Dec 2007 at 10:46

GoogleCodeExporter commented 9 years ago 
> a) add docstrings to
> http://svn.python.org/projects/python/branches/py3k/Lib/io.py

Yes, that is the task. Look for classes with a "XXX docstring" comment -- i.e.,
BytesIO, BufferedWriter, BufferedRandom. For BytesIO (and StringIO), you can 
use the
docstring of my C implementation as a reference:
http://svn.python.org/projects/python/branches/alex-py3k/Modules/_bytesio.c

For some classes, the documentation is incomplete or outdated -- e.g. the 
__init__
parameters and methods of TextIOWrapper are undocumented.

Original comment by avassalo...@gmail.com on 10 Dec 2007 at 11:01

GoogleCodeExporter commented 9 years ago 
Is there any progress?

Since your 5 days are over, you're now in the 3-day grace period which ends 
December
17, 22:45 UTC.

Original comment by georg.br...@gmail.com on 15 Dec 2007 at 10:13

GoogleCodeExporter commented 9 years ago 
Sorry! Due to some personal  reasons I had not time in the last days, I'll start
today but I'll probably need more time than the one day whis is left. Is that 
possible?

Original comment by m.ottene...@gmail.com on 17 Dec 2007 at 2:23

GoogleCodeExporter commented 9 years ago 
If you submit partial work to show progress, we'll evaluate it and decide on an
extension.  We've been pretty generous with them so far, so you shouldn't have 
any
problem if you show that you are actually working on the task.

Original comment by doug.hel...@gmail.com on 17 Dec 2007 at 2:36

GoogleCodeExporter commented 9 years ago 
Do you have a partial solution to share?  If you show that you're working on the
task, we can give you an extension.

Original comment by doug.hel...@gmail.com on 19 Dec 2007 at 12:42

GoogleCodeExporter commented 9 years ago 
Yes I'm at school at the moment I'll post it this evening(GMT+1)

Original comment by m.ottene...@gmail.com on 19 Dec 2007 at 12:50

GoogleCodeExporter commented 9 years ago 
This task will be reopened on Dec 23 unless you are able to post some partial
progress to show that you are actually working on it.

Original comment by doug.hel...@gmail.com on 22 Dec 2007 at 1:06

GoogleCodeExporter commented 9 years ago 
This task is reopened and available for anyone to claim.

Original comment by doug.hel...@gmail.com on 23 Dec 2007 at 1:34

GoogleCodeExporter commented 9 years ago 
I claim this task.

Original comment by cody.som...@gmail.com on 24 Dec 2007 at 7:38

GoogleCodeExporter commented 9 years ago 
This task is due Saturday December 29 at 20:00 UTC

Original comment by istvan.a...@gmail.com on 24 Dec 2007 at 8:36

GoogleCodeExporter commented 9 years ago 
As per comment 4, I've documented BytesIO, BufferedWriter, BufferedRandom as 
well as
StringIO.

Original comment by cody.som...@gmail.com on 27 Dec 2007 at 1:58

Attachments:

GoogleCodeExporter commented 9 years ago 
Hi, Cody, please write the docstrings so that the first line is standalone; see

http://www.python.org/dev/peps/pep-0257/

Other than that, this looks good.  Thanks!

Original comment by the.good...@gmail.com on 27 Dec 2007 at 7:04

GoogleCodeExporter commented 9 years ago 
Yes, it looks good. Although, I think slightly more could be done. For example,
BufferedReader's docstring need some love. Also, many methods are still 
undocumented
--  call help(io), from the interactive interpreter, to see what I mean. On the 
other
hand, io.py is still a prototype, so I don't think it would be a good idea to 
ask for
much more.

Thanks again for your help!

Original comment by avassalo...@gmail.com on 27 Dec 2007 at 8:02

GoogleCodeExporter commented 9 years ago 
This task is past due.  Please post a progress report if you intend to continue
working on it.

Original comment by doug.hel...@gmail.com on 4 Jan 2008 at 2:16

GoogleCodeExporter commented 9 years ago 
I apologize. I thought I had uploaded the updated diff. I'm off to an 
appointment
right now and will upload it when I get home.

Original comment by cody.som...@gmail.com on 4 Jan 2008 at 5:06

GoogleCodeExporter commented 9 years ago 
We're still waiting :)

Original comment by georg.br...@gmail.com on 6 Jan 2008 at 10:01

GoogleCodeExporter commented 9 years ago 
Hi. I think I've updated the one or two docstrings that didn't conform to PEP 
0257. I
also gave a bit of love to BufferedReader's docstring and gave a few more 
functions
docstrings.

Original comment by cody.som...@gmail.com on 7 Jan 2008 at 1:35

Attachments:

GoogleCodeExporter commented 9 years ago 
I've uploaded another diff that includes myself in the author attribute.

Original comment by cody.som...@gmail.com on 7 Jan 2008 at 1:40

Attachments:

GoogleCodeExporter commented 9 years ago 
Thanks!  I would appreciate it if you could truncate the first sentences of 
some of
the docstrings to be a single *line*, as in PEP 257/multi-line docstrings, but 
that
can be done quickly and I would prefer to let you go do another task if you're 
so
inclined!

Original comment by the.good...@gmail.com on 8 Jan 2008 at 9:15

GoogleCodeExporter commented 9 years ago 
I think I've fixed it now, see attachment :)

Original comment by cody.som...@gmail.com on 10 Jan 2008 at 5:10

Attachments:

GoogleCodeExporter commented 9 years ago 
Thanks!  That looks great...

Did you send in a Python contributor agreement form?

http://www.python.org/psf/contrib/contrib-form/

thanks,
--titus

Original comment by the.good...@gmail.com on 10 Jan 2008 at 7:52

GoogleCodeExporter commented 9 years ago 
Yes I have :)

Original comment by cody.som...@gmail.com on 24 Jan 2008 at 6:49

GoogleCodeExporter commented 9 years ago

Original comment by georg.br...@gmail.com on 17 May 2008 at 7:30