#15342: Add clarifying sentence to posixpath.join docstring.
authorR David Murray <rdmurray@bitdance.com>
Sat, 21 Jul 2012 18:33:56 +0000 (14:33 -0400)
committerR David Murray <rdmurray@bitdance.com>
Sat, 21 Jul 2012 18:33:56 +0000 (14:33 -0400)
This sentence appears as a clarifying note in the HTML docs, and seems
worth having in the docstring since it covers a very common use case
that isn't otherwise obvious.  Thanks to Yongzhi Pan for the suggestion.

Lib/posixpath.py

index 7a4daa8be946109852675081b1fb072acadbfb2f..2e3625bc6f16cbee2381f01e150d74643de1de75 100644 (file)
@@ -71,7 +71,8 @@ def isabs(s):
 def join(a, *p):
     """Join two or more pathname components, inserting '/' as needed.
     If any component is an absolute path, all previous path components
-    will be discarded."""
+    will be discarded.  An empty last part will result in a path that
+    ends with a separator."""
     sep = _get_sep(a)
     path = a
     try: