Skip to content

Commit 8cfe02b

Browse files
authored
Fix docstring for md.update() (#1203)
We use markup in docs, not in docstrings for C and Python code.
1 parent 5715939 commit 8cfe02b

File tree

4 files changed

+5
-2
lines changed

4 files changed

+5
-2
lines changed

CHANGES/1203.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replaced docstring for :meth:`multidict.MultiDict.update` to don't use RST/markdown markup.

docs/spelling_wordlist.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ fallback
3737
fastpath
3838
filename
3939
formatters
40+
RST
41+
docstring
4042
gcc
4143
getitem
4244
github

multidict/_multidict.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -822,7 +822,7 @@ PyDoc_STRVAR(multidict_popitem_doc,
822822
"Remove and return an arbitrary (key, value) pair.");
823823

824824
PyDoc_STRVAR(multidict_update_doc,
825-
"Update the dictionary from *other*, overwriting existing keys.");
825+
"Update the dictionary, overwriting existing keys.");
826826

827827
PyDoc_STRVAR(sizeof__doc__, "D.__sizeof__() -> size of D in memory, in bytes");
828828

multidict/_multidict_py.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -985,7 +985,7 @@ def popitem(self) -> tuple[str, _V]:
985985
return ret
986986

987987
def update(self, arg: MDArg[_V] = None, /, **kwargs: _V) -> None:
988-
"""Update the dictionary from *other*, overwriting existing keys."""
988+
"""Update the dictionary, overwriting existing keys."""
989989
items = self._parse_args(arg, kwargs)
990990
newsize = self._used + len(items)
991991
log2_size = estimate_log2_keysize(newsize)

0 commit comments

Comments
 (0)