[Python-checkins] bpo-38374: Remove weakref.ReferenceError from docs (GH-18452)
Miss Islington (bot)
webhook-mailer at python.org
Tue Feb 11 02:02:06 EST 2020
https://github.com/python/cpython/commit/3f8d181446aa9d87e3773896c2695161ea8f6e42
commit: 3f8d181446aa9d87e3773896c2695161ea8f6e42
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2020-02-10T23:02:01-08:00
summary:
bpo-38374: Remove weakref.ReferenceError from docs (GH-18452)
Reflecting changes to the code, removed weakref.ReferenceError from weakref.rst and exceptions.rst.
Issue submitter provided evidence that the `weakref.ReferenceError` alias for `ReferenceError` was removed from the code in 2007. Working with @gvanrossum at PyCascades CPython sprint we looked at the code and confirmed that `weakref.ReferenceError` was no longer in `weakref.py`.
Based on that analysis I removed references `weakref.ReferenceError` from the two documents where it was still being referenced: `weakref.rst` and `exceptions.rst`.
https://bugs.python.org/issue38374
(cherry picked from commit 4eb9f4313cfaea6a9611221024a1c54f5662cc37)
Co-authored-by: Roger Hurwitz <rogerhurwitz at gmail.com>
files:
M Doc/c-api/exceptions.rst
M Doc/library/weakref.rst
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index c7ba74cc8d587..7300c802e0817 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -971,9 +971,6 @@ Notes:
This is a base class for other standard exceptions.
(2)
- This is the same as :exc:`weakref.ReferenceError`.
-
-(3)
Only defined on Windows; protect code that uses this by testing that the
preprocessor macro ``MS_WINDOWS`` is defined.
diff --git a/Doc/library/weakref.rst b/Doc/library/weakref.rst
index b3c8e35455331..2dbe5e33bd011 100644
--- a/Doc/library/weakref.rst
+++ b/Doc/library/weakref.rst
@@ -327,12 +327,6 @@ objects.
types.
-.. exception:: ReferenceError
-
- Exception raised when a proxy object is used but the underlying object has been
- collected. This is the same as the standard :exc:`ReferenceError` exception.
-
-
.. seealso::
:pep:`205` - Weak References
More information about the Python-checkins
mailing list