Skip to content

Commit eebdb18

Browse files
Update thebroke RST markup in items() method docstrings (#1299)
## Summary Fix malformed RST markup in the `items()` docstrings of `MultiDict` and `MultiDictProxy`. The original text `*(key, value) pairs)` has been present since the initial commit (f84e6bc). It has an unmatched `*` (opening RST emphasis with no closing `*`) and an extra trailing `)`. Changed to `((key, value) pairs)` to use plain parentheses matching the tuple notation. Co-authored-by: Sam Bull <[email protected]> Co-authored-by: Sam Bull <[email protected]>
1 parent dbebab0 commit eebdb18

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

CHANGES/1299.bugfix.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Fixed broken RST markup in ``items()`` docstrings
2+
-- by :user:`veeceey`.

multidict/_multidict_py.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -720,7 +720,7 @@ def keys(self) -> KeysView[str]:
720720
return _KeysView(self)
721721

722722
def items(self) -> ItemsView[str, _V]:
723-
"""Return a new view of the dictionary's items *(key, value) pairs)."""
723+
"""Return a new view of the dictionary's items as ``(key, value)`` pairs."""
724724
return _ItemsView(self)
725725

726726
def values(self) -> _ValuesView[_V]:
@@ -1194,7 +1194,7 @@ def keys(self) -> KeysView[str]:
11941194
return self._md.keys()
11951195

11961196
def items(self) -> ItemsView[str, _V]:
1197-
"""Return a new view of the dictionary's items *(key, value) pairs)."""
1197+
"""Return a new view of the dictionary's items as ``(key, value)`` pairs."""
11981198
return self._md.items()
11991199

12001200
def values(self) -> _ValuesView[_V]:

0 commit comments

Comments
 (0)