Skip to content

[3.10] bpo-43721: Fix docstrings for property.getter/setter/deleter (GH-31046) #31887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miss-islington merged 1 commit into from
Mar 14, 2022
Merged

[3.10] bpo-43721: Fix docstrings for property.getter/setter/deleter (GH-31046) #31887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Core and Builtins/2022-02-01-10-05-27.bpo-43721.-1XAIo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix docstrings of :attr:`~property.getter`, :attr:`~property.setter`, and :attr:`~property.deleter` to clarify that they create a new copy of the property.
6 changes: 3 additions & 3 deletions Objects/descrobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1510,7 +1510,7 @@ static PyMemberDef property_members[] = {


PyDoc_STRVAR(getter_doc,
"Descriptor to change the getter on a property.");
"Descriptor to obtain a copy of the property with a different getter.");

static PyObject *
property_getter(PyObject *self, PyObject *getter)
Expand All @@ -1520,7 +1520,7 @@ property_getter(PyObject *self, PyObject *getter)


PyDoc_STRVAR(setter_doc,
"Descriptor to change the setter on a property.");
"Descriptor to obtain a copy of the property with a different setter.");

static PyObject *
property_setter(PyObject *self, PyObject *setter)
Expand All @@ -1530,7 +1530,7 @@ property_setter(PyObject *self, PyObject *setter)


PyDoc_STRVAR(deleter_doc,
"Descriptor to change the deleter on a property.");
"Descriptor to obtain a copy of the property with a different deleter.");

static PyObject *
property_deleter(PyObject *self, PyObject *deleter)
Expand Down