[Python-checkins] The current documentation says it returns None if the name is not found, but (GH-26785)

Mon Jul 26 12:18:29 EDT 2021

https://github.com/python/cpython/commit/f22737abfa07605f4ed1a99cfa97a26520b6c5c2
commit: f22737abfa07605f4ed1a99cfa97a26520b6c5c2
branch: main
author: Jelle Zijlstra <jelle.zijlstra at gmail.com>
committer: ambv <lukasz at langa.pl>
date: 2021年07月26日T18:18:19+02:00
summary:
The current documentation says it returns None if the name is not found, but (GH-26785)
the implementation uses [] and will raise KeyError instead.
Noticed by @srittau in python/typeshed at 5659.
files:
A Misc/NEWS.d/next/Documentation/2021-06-18-06-44-45.bpo-44453.3PIkj2.rst
M Doc/library/sysconfig.rst

diff --git a/Doc/library/sysconfig.rst b/Doc/library/sysconfig.rst
index bb8e2d88c0fc9..2de55d86c38f4 100644
--- a/Doc/library/sysconfig.rst
+++ b/Doc/library/sysconfig.rst
@@ -175,7 +175,7 @@ identifier. Python currently uses eight paths:
 If *expand* is set to ``False``, the path will not be expanded using the
 variables.
 
- If *name* is not found, return ``None``.
+ If *name* is not found, raise a :exc:`KeyError`.
 
 
 .. function:: get_paths([scheme, [vars, [expand]]])
diff --git a/Misc/NEWS.d/next/Documentation/2021-06-18-06-44-45.bpo-44453.3PIkj2.rst b/Misc/NEWS.d/next/Documentation/2021-06-18-06-44-45.bpo-44453.3PIkj2.rst
new file mode 100644
index 0000000000000..fd72cf525c32f
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2021-06-18-06-44-45.bpo-44453.3PIkj2.rst
@@ -0,0 +1 @@
+Fix documentation for the return type of :func:`sysconfig.get_path`.
