From 68a5d6c0cfec980163a845ed297626299fc29979 Mon Sep 17 00:00:00 2001
From: Dino Viehland <dinoviehland@fb.com>
Date: Fri, 19 Jan 2024 10:45:49 -0800
Subject: [PATCH] Improve doc strings

---
 Objects/clinic/dictobject.c.h | 14 +++++++-------
 Objects/dictobject.c          | 24 ++++++++++++------------
 2 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/Objects/clinic/dictobject.c.h b/Objects/clinic/dictobject.c.h
index 3259c9a7bcce8f..50ac290bf3f804 100644
--- a/Objects/clinic/dictobject.c.h
+++ b/Objects/clinic/dictobject.c.h
@@ -42,7 +42,7 @@ PyDoc_STRVAR(dict_copy__doc__,
 "copy($self, /)\n"
 "--\n"
 "\n"
-"D.copy() -> a shallow copy of D");
+"Returns a shallow copy of D.");
 
 #define DICT_COPY_METHODDEF    \
     {"copy", (PyCFunction)dict_copy, METH_NOARGS, dict_copy__doc__},
@@ -140,7 +140,7 @@ PyDoc_STRVAR(dict_clear__doc__,
 "clear($self, /)\n"
 "--\n"
 "\n"
-"D.clear() -> None.  Remove all items from D.");
+"Removes all items.");
 
 #define DICT_CLEAR_METHODDEF    \
     {"clear", (PyCFunction)dict_clear, METH_NOARGS, dict_clear__doc__},
@@ -216,7 +216,7 @@ PyDoc_STRVAR(dict___sizeof____doc__,
 "__sizeof__($self, /)\n"
 "--\n"
 "\n"
-"D.__sizeof__() -> size of D in memory, in bytes");
+"Returns size of D in memory, in bytes.");
 
 #define DICT___SIZEOF___METHODDEF    \
     {"__sizeof__", (PyCFunction)dict___sizeof__, METH_NOARGS, dict___sizeof____doc__},
@@ -252,7 +252,7 @@ PyDoc_STRVAR(dict_keys__doc__,
 "keys($self, /)\n"
 "--\n"
 "\n"
-"D.keys() -> a set-like object providing a view on D\'s keys");
+"Returns a set-like object providing a view on D\'s keys.");
 
 #define DICT_KEYS_METHODDEF    \
     {"keys", (PyCFunction)dict_keys, METH_NOARGS, dict_keys__doc__},
@@ -270,7 +270,7 @@ PyDoc_STRVAR(dict_items__doc__,
 "items($self, /)\n"
 "--\n"
 "\n"
-"D.items() -> a set-like object providing a view on D\'s items");
+"Returns a set-like object providing a view on D\'s items.");
 
 #define DICT_ITEMS_METHODDEF    \
     {"items", (PyCFunction)dict_items, METH_NOARGS, dict_items__doc__},
@@ -288,7 +288,7 @@ PyDoc_STRVAR(dict_values__doc__,
 "values($self, /)\n"
 "--\n"
 "\n"
-"D.values() -> an object providing a view on D\'s values");
+"Returns an object providing a view on D\'s values.");
 
 #define DICT_VALUES_METHODDEF    \
     {"values", (PyCFunction)dict_values, METH_NOARGS, dict_values__doc__},
@@ -301,4 +301,4 @@ dict_values(PyDictObject *self, PyObject *Py_UNUSED(ignored))
 {
     return dict_values_impl(self);
 }
-/*[clinic end generated code: output=852c83b680d0a4a0 input=a9049054013a1b77]*/
+/*[clinic end generated code: output=7b0c1b786b53efcf input=a9049054013a1b77]*/
diff --git a/Objects/dictobject.c b/Objects/dictobject.c
index 5df39bcb0b0ea8..bd37c90ea3c475 100644
--- a/Objects/dictobject.c
+++ b/Objects/dictobject.c
@@ -3126,12 +3126,12 @@ _PyDict_MergeEx(PyObject *a, PyObject *b, int override)
 /*[clinic input]
 dict.copy
 
-D.copy() -> a shallow copy of D
+Returns a shallow copy of D.
 [clinic start generated code]*/
 
 static PyObject *
 dict_copy_impl(PyDictObject *self)
-/*[clinic end generated code: output=ffb782cf970a5c39 input=b96949d603dc505c]*/
+/*[clinic end generated code: output=ffb782cf970a5c39 input=6d9903c1b6362e32]*/
 {
     return PyDict_Copy((PyObject *)self);
 }
@@ -3508,12 +3508,12 @@ dict_setdefault_impl(PyDictObject *self, PyObject *key,
 /*[clinic input]
 dict.clear
 
-D.clear() -> None.  Remove all items from D.
+Removes all items.
 [clinic start generated code]*/
 
 static PyObject *
 dict_clear_impl(PyDictObject *self)
-/*[clinic end generated code: output=5139a830df00830a input=31e16ad16e56f4dc]*/
+/*[clinic end generated code: output=5139a830df00830a input=1824e4e555dfaf79]*/
 {
     PyDict_Clear((PyObject *)self);
     Py_RETURN_NONE;
@@ -3706,12 +3706,12 @@ _PyDict_KeysSize(PyDictKeysObject *keys)
 /*[clinic input]
 dict.__sizeof__
 
-D.__sizeof__() -> size of D in memory, in bytes
+Returns size of D in memory, in bytes.
 [clinic start generated code]*/
 
 static PyObject *
 dict___sizeof___impl(PyDictObject *self)
-/*[clinic end generated code: output=44279379b3824bda input=bcde0197a346f7ce]*/
+/*[clinic end generated code: output=44279379b3824bda input=33b3550475672efd]*/
 {
     return PyLong_FromSsize_t(_PyDict_SizeOf(self));
 }
@@ -5247,12 +5247,12 @@ PyTypeObject PyDictKeys_Type = {
 /*[clinic input]
 dict.keys
 
-D.keys() -> a set-like object providing a view on D's keys
+Returns a set-like object providing a view on D's keys.
 [clinic start generated code]*/
 
 static PyObject *
 dict_keys_impl(PyDictObject *self)
-/*[clinic end generated code: output=aac2830c62990358 input=4a20806094eaaed1]*/
+/*[clinic end generated code: output=aac2830c62990358 input=26448b0710052252]*/
 {
     return _PyDictView_New((PyObject *)self, &PyDictKeys_Type);
 }
@@ -5359,12 +5359,12 @@ PyTypeObject PyDictItems_Type = {
 /*[clinic input]
 dict.items
 
-D.items() -> a set-like object providing a view on D's items
+Returns a set-like object providing a view on D's items.
 [clinic start generated code]*/
 
 static PyObject *
 dict_items_impl(PyDictObject *self)
-/*[clinic end generated code: output=88c7db7150c7909a input=7c47bcbd09b31e59]*/
+/*[clinic end generated code: output=88c7db7150c7909a input=21ee5e4c8ead76c4]*/
 {
     return _PyDictView_New((PyObject *)self, &PyDictItems_Type);
 }
@@ -5449,12 +5449,12 @@ PyTypeObject PyDictValues_Type = {
 /*[clinic input]
 dict.values
 
-D.values() -> an object providing a view on D's values
+Returns an object providing a view on D's values.
 [clinic start generated code]*/
 
 static PyObject *
 dict_values_impl(PyDictObject *self)
-/*[clinic end generated code: output=ce9f2e9e8a959dd4 input=004353e8ab5d1aa9]*/
+/*[clinic end generated code: output=ce9f2e9e8a959dd4 input=53354b69fc077e0d]*/
 {
     return _PyDictView_New((PyObject *)self, &PyDictValues_Type);
 }