Skip to content

Commit b24566e

Browse files
committed
Reviewed docstring of ApiParams class
1 parent cea96ab commit b24566e

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

pylls/cachet.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,15 @@ class ApiParams(dict):
2525
"""API parameters storage
2626
2727
Convenience class for API parameters management.
28-
setitem override to skip None value items.
28+
The :meth:`__setitem__` method is overridden to skip None value items.
29+
30+
**Example:**
31+
32+
>>> params = ApiParams(first=1, second=2)
33+
>>> params['none'] = None
34+
>>> params['third'] = 3
35+
>>> print(sorted(params.items()))
36+
[('first', 1), ('second', 2), ('third', 3)]
2937
"""
3038
def __setitem__(self, key, value):
3139
if value is not None:

0 commit comments

Comments
 (0)