Issue1758904
Created on 2007-07-23.14:43:07 by markacy, last changed 2007-09-24.01:25:30 by pjenvey.
File name |
Uploaded |
Description |
Edit |
Remove |
javaos.patch
|
markacy,
2007-09-04.19:53:11
|
Improved patch adding docstrings to os module (javaos.py) |
|
|
msg2733 (view) |
Author: Marek Szczypinski (markacy) |
Date: 2007-07-23.14:43:07 |
|
I added doc strings for functions in os module (file javaos.py). Didn't change anything else.
|
msg2734 (view) |
Author: Pekka Klärck (pekka.klarck) |
Date: 2007-07-27.00:04:41 |
|
I looked at the patch briefly and in general docstrings look good to me especially compared to current ones. Some things that could still be fixed are listed below.
- Added docstrings aren't always following PEP 257 Docstring Conventions available at http://www.python.org/dev/peps/pep-0257/
- Docstrings on Python 2.5 os.py have more content than these so perhaps they could be used as a base (keeping in mind that there can be differences between versions).
- Mentioning java2 is not really needed in utime since, AFAIK, it means Java 1.2 and Java 1.4 is the minimum for Jython 2.2. The check 'hasattr(File, "setLastModified")' should probably also be removed from the code.
- The doc for utime could be slightly more clear since now it first says that atime and mtime are changed and then that only mtime is. Mentioning that the latter is due to Java limitations might be good.
- It would be helpful to tell what information is actually returned by stat.
|
msg2735 (view) |
Author: Pekka Klärck (pekka.klarck) |
Date: 2007-07-29.21:51:23 |
|
I submitted a bug [1] about missing utime(path, None) and included a simple patch to fix it.
[1] http://jython.org/bugs/1763263
|
msg2736 (view) |
Author: Marek Szczypinski (markacy) |
Date: 2007-09-04.19:53:15 |
|
File Added: javaos.patch
|
msg2737 (view) |
Author: Philip Jenvey (pjenvey) |
Date: 2007-09-24.01:24:27 |
|
committed in r3519/3520 with a couple small changes:
o a few new docstrings were longer than 72 chars (PEP 8)
o added a trailing period in a couple places
o added docs for _exit and chdir
o added method signatures to all the docstrings, like CPython includes
committed to branch in r3522
|
msg2738 (view) |
Author: Philip Jenvey (pjenvey) |
Date: 2007-09-24.01:25:30 |
|
and thanks!
|
|
Date |
User |
Action |
Args |
2007-07-23 14:43:07 | markacy | create | |
|