[docs] Add an os.path <=> pathlib equivalence table in pathlib docs (issue 24899)

m.recachinas at gmail.com m.recachinas at gmail.com
Fri Jan 1 19:12:38 EST 2016


I've reviewed the patch -- it looks good. There's one small change
(grp.getpwuid -> pwd.getpwuid on line 1070), but no other inaccuracies.
As I noted in the line-by-line patch review, the multi-line rows (e.g.,
lines 1046 - 1047 or 1069 - 1070) render differently in the html (with
`make html`). I tried adding another newline in between, but this
introduced excess whitespace in the rendered html.


http://bugs.python.org/review/24899/diff/15552/Doc/library/pathlib.rst
File Doc/library/pathlib.rst (right):

http://bugs.python.org/review/24899/diff/15552/Doc/library/pathlib.rst#newcode1047
Doc/library/pathlib.rst:1047: |                        |
grp.getgrgid()[0]       |
This row (lines 1046 - 1047) and lines 1069 - 1070 look perfectly
formatted here in the .rst file, but when you build the docs,
`os.stat()` and `grp.getgrgid()[0]` appear as one line separated by a
space, and the `[0]` trails on the next line. Unsure if this is an
issue, but it's worth mentioning as a formatting comment.

http://bugs.python.org/review/24899/diff/15552/Doc/library/pathlib.rst#newcode1070
Doc/library/pathlib.rst:1070: |                        |
grp.getpwuid()[0]       |
The `grp` module has no member function `getpwuid`. `getpwuid` is
located in the `pwd` module.

http://bugs.python.org/review/24899/


More information about the docs mailing list