gh-90982: Document prefixes argument on site.getsitepackages (GH-31546)

https://github.com/python/cpython/commit/bc31217fe432b5ede1485bec2b62b2c67a48eee4
commit: bc31217fe432b5ede1485bec2b62b2c67a48eee4
branch: main
author: Addison Snelling <[email protected]>
committer: serhiy-storchaka <[email protected]>
date: 2026-08-12T20:16:47Z
summary:

gh-90982: Document prefixes argument on site.getsitepackages (GH-31546)

files:
M Doc/library/site.rst

diff --git a/Doc/library/site.rst b/Doc/library/site.rst
index 11a5484c2b1336..6f989e2b21b8bf 100644
--- a/Doc/library/site.rst
+++ b/Doc/library/site.rst
@@ -449,12 +449,19 @@ Module contents
       Also processes :file:`.start` files.  See :ref:`site-start-files`.
 
 
-.. function:: getsitepackages()
+.. function:: getsitepackages(prefixes=None)
 
    Return a list containing all global site-packages directories.
 
+   For each directory present in *prefixes* (or :data:`PREFIXES` if *prefixes*
+   is ``None``), this function will find its site-packages subdirectory
+   depending on the system environment, and will return a list of full paths.
+
    .. versionadded:: 3.2
 
+   .. versionchanged:: 3.3
+      Add the optional *prefixes* argument.
+
 
 .. function:: getuserbase()
 

_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]