summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorYury Selivanov <yselivanov@sprymix.com>2015-08-18 03:43:43 (GMT)
committerYury Selivanov <yselivanov@sprymix.com>2015-08-18 03:43:43 (GMT)
commit80ac11f95f1c6b3f11f25de074a2d6eb1e261dc2 (patch)
treefe894f04fe129f50b2b8f006204bb50dd5b3ffa9 /Doc/library
parentd61714d236138ac7dc0228ee90314dfa8c3cc04d (diff)
downloadcpython-80ac11f95f1c6b3f11f25de074a2d6eb1e261dc2.zip
cpython-80ac11f95f1c6b3f11f25de074a2d6eb1e261dc2.tar.gz
cpython-80ac11f95f1c6b3f11f25de074a2d6eb1e261dc2.tar.bz2
docs: Improve docs for os.path.commonprefix
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/os.path.rst17
1 files changed, 15 insertions, 2 deletions
diff --git a/Doc/library/os.path.rst b/Doc/library/os.path.rst
index e4fe44e..041277c 100644
--- a/Doc/library/os.path.rst
+++ b/Doc/library/os.path.rst
@@ -82,8 +82,21 @@ the :mod:`glob` module.)
Return the longest path prefix (taken character-by-character) that is a
prefix of all paths in *list*. If *list* is empty, return the empty string
- (``''``). Note that this may return invalid paths because it works a
- character at a time. To obtain a valid path, see :func:`commonpath`.
+ (``''``).
+
+ .. note::
+
+ This function may return invalid paths because it works a
+ character at a time. To obtain a valid path, see
+ :func:`commonpath`.
+
+ ::
+
+ >>> os.path.commonprefix(['/dir1/dir2', '/dir3/dir4'])
+ '/dir'
+
+ >>> os.path.commonpath(['/dir1/dir2', '/dir3/dir4'])
+ '/'
.. function:: dirname(path)