[ python-Bugs-1688564 ] os.path.join.__doc__ should mention absolute paths

[SourceForge.net]

Bugs item #1688564, was opened at 2007-03-26 13:12
Message generated for change (Comment added) made by collinwinter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1688564&group_id=5470

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation
Group: Python 2.4
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Eugene Kramer (zdes)
Assigned to: Nobody/Anonymous (nobody)
Summary: os.path.join.__doc__ should mention absolute paths

Initial Comment:
Currently, automatically generated docs from os.path.join do not mention that all paths prior to the last absolute path are discarded.

The __doc__ says:
"Join two or more pathname components, inserting '/' as needed"

>From this documentation, it is not obvious that os.path.join("abc", "/cde", "fgh") results in "/cde/fgh".

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

>Comment By: Collin Winter (collinwinter)
Date: 2007-03-28 17:48

Message:
Logged In: YES 
user_id=1344176
Originator: NO

"""Join two or more pathname components, inserting '/' as needed. If any
component is an absolute path, all previous path components will be
discarded."""

Does that work for you? Could you come up with language that you'd prefer
to see?

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

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