Skip to content

Commit 7f01a11

Browse files
authored
GH-100989: Revert Improve the accuracy of collections.deque docstrings (GH-102979)
1 parent 413b7db commit 7f01a11

File tree

1 file changed

+13
-24
lines changed

1 file changed

+13
-24
lines changed

Modules/_collectionsmodule.c

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -910,9 +910,7 @@ deque_rotate(dequeobject *deque, PyObject *const *args, Py_ssize_t nargs)
910910
}
911911

912912
PyDoc_STRVAR(rotate_doc,
913-
"rotate(n)\n\n"
914-
"Rotate the deque *n* steps to the right (default ``n=1``). "
915-
"If *n* is negative, rotates left.");
913+
"Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.");
916914

917915
static PyObject *
918916
deque_reverse(dequeobject *deque, PyObject *unused)
@@ -953,8 +951,7 @@ deque_reverse(dequeobject *deque, PyObject *unused)
953951
}
954952

955953
PyDoc_STRVAR(reverse_doc,
956-
"reverse()\n\n"
957-
"Reverse the elements of the deque *IN PLACE*.");
954+
"D.reverse() -- reverse *IN PLACE*");
958955

959956
static PyObject *
960957
deque_count(dequeobject *deque, PyObject *v)
@@ -993,8 +990,7 @@ deque_count(dequeobject *deque, PyObject *v)
993990
}
994991

995992
PyDoc_STRVAR(count_doc,
996-
"count(x) -> int\n\n"
997-
"Count the number of deque elements equal to *x*.");
993+
"D.count(value) -> integer -- return number of occurrences of value");
998994

999995
static int
1000996
deque_contains(dequeobject *deque, PyObject *v)
@@ -1102,10 +1098,8 @@ deque_index(dequeobject *deque, PyObject *const *args, Py_ssize_t nargs)
11021098
}
11031099

11041100
PyDoc_STRVAR(index_doc,
1105-
"index(x, [start, [stop]]) -> int\n\n"
1106-
"Return the position of *x* in the deque "
1107-
"(at or after index *start* and before index *stop*). "
1108-
"Returns the first match or raises a ValueError if not found.");
1101+
"D.index(value, [start, [stop]]) -> integer -- return first index of value.\n"
1102+
"Raises ValueError if the value is not present.");
11091103

11101104
/* insert(), remove(), and delitem() are implemented in terms of
11111105
rotate() for simplicity and reasonable performance near the end
@@ -1150,13 +1144,10 @@ deque_insert(dequeobject *deque, PyObject *const *args, Py_ssize_t nargs)
11501144
}
11511145

11521146
PyDoc_STRVAR(insert_doc,
1153-
"insert(i, x)\n\n"
1154-
"Insert *x* into the deque at position *i*.");
1147+
"D.insert(index, object) -- insert object before index");
11551148

11561149
PyDoc_STRVAR(remove_doc,
1157-
"remove(x)\n\n"
1158-
"Remove the first occurrence of *x*."
1159-
"If not found, raises a ValueError.");
1150+
"D.remove(value) -- remove first occurrence of value.");
11601151

11611152
static int
11621153
valid_index(Py_ssize_t i, Py_ssize_t limit)
@@ -1527,8 +1518,7 @@ deque_sizeof(dequeobject *deque, void *unused)
15271518
}
15281519

15291520
PyDoc_STRVAR(sizeof_doc,
1530-
"__sizeof__() -> int\n\n"
1531-
"Size of the deque in memory, in bytes.");
1521+
"D.__sizeof__() -- size of D in memory, in bytes");
15321522

15331523
static PyObject *
15341524
deque_get_maxlen(dequeobject *deque, void *Py_UNUSED(ignored))
@@ -1563,8 +1553,7 @@ static PySequenceMethods deque_as_sequence = {
15631553
static PyObject *deque_iter(dequeobject *deque);
15641554
static PyObject *deque_reviter(dequeobject *deque, PyObject *Py_UNUSED(ignored));
15651555
PyDoc_STRVAR(reversed_doc,
1566-
"__reversed__()\n\n"
1567-
"Return a reverse iterator over the deque.");
1556+
"D.__reversed__() -- return a reverse iterator over the deque");
15681557

15691558
static PyMethodDef deque_methods[] = {
15701559
{"append", (PyCFunction)deque_append,
@@ -1609,8 +1598,9 @@ static PyMethodDef deque_methods[] = {
16091598
};
16101599

16111600
PyDoc_STRVAR(deque_doc,
1612-
"deque([iterable[, maxlen]]) -> collections.deque\n\n"
1613-
"A list-like sequence optimized for data accesses near its endpoints.");
1601+
"deque([iterable[, maxlen]]) --> deque object\n\
1602+
\n\
1603+
A list-like sequence optimized for data accesses near its endpoints.");
16141604

16151605
static PyTypeObject deque_type = {
16161606
PyVarObject_HEAD_INIT(NULL, 0)
@@ -1989,8 +1979,7 @@ new_defdict(defdictobject *dd, PyObject *arg)
19891979
dd->default_factory ? dd->default_factory : Py_None, arg, NULL);
19901980
}
19911981

1992-
PyDoc_STRVAR(defdict_copy_doc, "copy() -> collections.deque\n\n"
1993-
"A shallow copy of the deque.");
1982+
PyDoc_STRVAR(defdict_copy_doc, "D.copy() -> a shallow copy of D.");
19941983

19951984
static PyObject *
19961985
defdict_copy(defdictobject *dd, PyObject *Py_UNUSED(ignored))

0 commit comments

Comments
 (0)