Skip to content

Commit bc31217

Browse files
authored
gh-90982: Document prefixes argument on site.getsitepackages (GH-31546)
1 parent 5dfa606 commit bc31217

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

Doc/library/site.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -449,12 +449,19 @@ Module contents
449449
Also processes :file:`.start` files. See :ref:`site-start-files`.
450450

451451

452-
.. function:: getsitepackages()
452+
.. function:: getsitepackages(prefixes=None)
453453

454454
Return a list containing all global site-packages directories.
455455

456+
For each directory present in *prefixes* (or :data:`PREFIXES` if *prefixes*
457+
is ``None``), this function will find its site-packages subdirectory
458+
depending on the system environment, and will return a list of full paths.
459+
456460
.. versionadded:: 3.2
457461

462+
.. versionchanged:: 3.3
463+
Add the optional *prefixes* argument.
464+
458465

459466
.. function:: getuserbase()
460467

0 commit comments

Comments
 (0)