From: Barney Gale <barney.gale@gmail.com>
Date: Sat, 13 Jan 2024 08:47:00 +0000 (+0000)
Subject: Add module docstring for `pathlib._abc`. (#113691)
X-Git-Tag: v3.13.0a3~54
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=21f83efd106a19f1d26e049c06678a6729a721f0;p=thirdparty%2FPython%2Fcpython.git

Add module docstring for `pathlib._abc`. (#113691)
---

diff --git a/Lib/pathlib/_abc.py b/Lib/pathlib/_abc.py
index e53921edaa2c..a6956f251f8b 100644
--- a/Lib/pathlib/_abc.py
+++ b/Lib/pathlib/_abc.py
@@ -1,3 +1,16 @@
+"""
+Abstract base classes for rich path objects.
+
+This module is published as a PyPI package called "pathlib-abc".
+
+This module is also a *PRIVATE* part of the Python standard library, where
+it's developed alongside pathlib. If it finds success and maturity as a PyPI
+package, it could become a public part of the standard library.
+
+Two base classes are defined here -- PurePathBase and PathBase -- that
+resemble pathlib's PurePath and Path respectively.
+"""
+
 import functools
 import posixpath
 from errno import ENOENT, ENOTDIR, EBADF, ELOOP, EINVAL