Skip to content

Commit f1a5e1b

Browse files
bpo-43721: Fix docstrings for property.getter/setter/deleter (GH-31046)
(cherry picked from commit e3d348a) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
1 parent 73943ce commit f1a5e1b

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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.

‎Objects/descrobject.c‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1508,7 +1508,7 @@ static PyMemberDef property_members[] = {
15081508

15091509

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

15131513
static PyObject *
15141514
property_getter(PyObject *self, PyObject *getter)
@@ -1518,7 +1518,7 @@ property_getter(PyObject *self, PyObject *getter)
15181518

15191519

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

15231523
static PyObject *
15241524
property_setter(PyObject *self, PyObject *setter)
@@ -1528,7 +1528,7 @@ property_setter(PyObject *self, PyObject *setter)
15281528

15291529

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

15331533
static PyObject *
15341534
property_deleter(PyObject *self, PyObject *deleter)

0 commit comments

Comments
 (0)