From: R David Murray <rdmurray@bitdance.com>
Date: Sat, 21 Jul 2012 18:37:29 +0000 (-0400)
Subject: #15342: Add clarifying sentence to posixpath.join docstring.
X-Git-Tag: v2.7.5~109^2~437^2~3
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ac9b5c67d35ee100ff1d80f4d55c307aab4ca4e7;p=python

#15342: Add clarifying sentence to posixpath.join docstring.

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.
---

diff --git a/Lib/posixpath.py b/Lib/posixpath.py
index 690c70da37..5ddf25b106 100644
--- a/Lib/posixpath.py
+++ b/Lib/posixpath.py
@@ -68,7 +68,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."""
     path = a
     for b in p:
         if b.startswith('/'):