summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Lib/pathlib.py12
-rw-r--r--Misc/NEWS.d/next/Library/2019-10-09-18-16-51.bpo-38422.aiM5bq.rst1
2 files changed, 11 insertions, 2 deletions
diff --git a/Lib/pathlib.py b/Lib/pathlib.py
index 825533d..d70fde0 100644
--- a/Lib/pathlib.py
+++ b/Lib/pathlib.py
@@ -799,7 +799,11 @@ class PurePath(object):
@property
def suffix(self):
- """The final component's last suffix, if any."""
+ """
+ The final component's last suffix, if any.
+
+ This includes the leading period. For example: '.txt'
+ """
name = self.name
i = name.rfind('.')
if 0 < i < len(name) - 1:
@@ -809,7 +813,11 @@ class PurePath(object):
@property
def suffixes(self):
- """A list of the final component's suffixes, if any."""
+ """
+ A list of the final component's suffixes, if any.
+
+ These include the leading periods. For example: ['.tar', '.gz']
+ """
name = self.name
if name.endswith('.'):
return []
diff --git a/Misc/NEWS.d/next/Library/2019-10-09-18-16-51.bpo-38422.aiM5bq.rst b/Misc/NEWS.d/next/Library/2019-10-09-18-16-51.bpo-38422.aiM5bq.rst
new file mode 100644
index 0000000..0958fe2
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2019-10-09-18-16-51.bpo-38422.aiM5bq.rst
@@ -0,0 +1 @@
+Clarify docstrings of pathlib suffix(es)