[Python-bugs-list] [ python-Bugs-469732 ] os.path.walk docstring inconsistent

[noreply@sourceforge.net]

Bugs item #469732, was opened at 2001-10-09 18:36
You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=469732&group_id=5470

Category: Documentation
Group: None
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: Mark Hammond (mhammond)
Assigned to: Tim Peters (tim_one)
Summary: os.path.walk docstring inconsistent

Initial Comment:
On Windows, the docstring for os.path.walk says (in 
ntpath.py

    """Directory tree walk whth callback function.

    walk(top, func, arg) calls func(arg, d, files) for 
each directory d
    in the tree rooted at top (including top itself); 
files is a list
    of all the files and subdirs in directory d."""

(*** Note the "whth" in the first line ***)

Comparing with posixpath.py, the entire first line of 
the docstring is missing.

I would have simply corrected the spelling of "whth", 
but when I noticed that the 2 platforms' strings were 
different I decided to open this bug and allow Tim to 
make a quick decision about which string is the 
correct one.

Feel free to punt back, but I am guessing it quicker 
for you to make the decision and check it in.

----------------------------------------------------------------------

>Comment By: Tim Peters (tim_one)
Date: 2001-10-09 21:18

Message:
Logged In: YES 
user_id=31435

After long thought, I decided "whth" was a typo <wink>.

It's actually worse than you thought:  we appear to have 5 
implementations of walk(), with 5 different docstrings.  I 
tried to combine the best of all of them, and then fiddled 
the result to tell the truth.

Lib/dospath.py; new revision: 1.25
Lib/macpath.py; new revision: 1.31
Lib/ntpath.py; new revision: 1.43
Lib/posixpath.py; new revision: 1.46
Lib/plat-riscos/riscospath.py; new revision: 1.6


----------------------------------------------------------------------

You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=469732&group_id=5470