From: Antoine Pitrou <solipsis@pitrou.net>
Date: Tue, 25 Feb 2014 19:33:02 +0000 (+0100)
Subject: Issue #20765: Add missing documentation for PurePath.with_name() and PurePath.with_su... 
X-Git-Tag: v3.4.1rc1~233^2~199
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ef85119618e7ba7717a36172675a7d4d5aef4954;p=thirdparty%2FPython%2Fcpython.git

Issue #20765: Add missing documentation for PurePath.with_name() and PurePath.with_suffix().
---

diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index 3aa9d4b33b6d..ec1dc4f6168c 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -522,6 +522,36 @@ Pure paths provide the following methods and properties:
       ValueError: '/etc/passwd' does not start with '/usr'
 
 
+.. method:: PurePath.with_name(name)
+
+   Return a new path with the :attr:`name` changed.  If the original path
+   doesn't have a name, ValueError is raised::
+
+      >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
+      >>> p.with_name('setup.py')
+      PureWindowsPath('c:/Downloads/setup.py')
+      >>> p = PureWindowsPath('c:/')
+      >>> p.with_name('setup.py')
+      Traceback (most recent call last):
+        File "<stdin>", line 1, in <module>
+        File "/home/antoine/cpython/default/Lib/pathlib.py", line 751, in with_name
+          raise ValueError("%r has an empty name" % (self,))
+      ValueError: PureWindowsPath('c:/') has an empty name
+
+
+.. method:: PurePath.with_suffix(suffix)
+
+   Return a new path with the :attr:`suffix` changed.  If the original path
+   doesn't have a suffix, the new *suffix* is appended instead::
+
+      >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
+      >>> p.with_suffix('.bz2')
+      PureWindowsPath('c:/Downloads/pathlib.tar.bz2')
+      >>> p = PureWindowsPath('README')
+      >>> p.with_suffix('.txt')
+      PureWindowsPath('README.txt')
+
+
 .. _concrete-paths:
 
 
diff --git a/Misc/NEWS b/Misc/NEWS
index 9f9c98171b49..b11cd2e0526f 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -17,6 +17,12 @@ Library
 - Issue #19748: On AIX, time.mktime() now raises an OverflowError for year
   outsize range [1902; 2037].
 
+Documentation
+-------------
+
+- Issue #20765: Add missing documentation for PurePath.with_name() and
+  PurePath.with_suffix().
+
 Tests
 -----