Skip to content

Commit e7ea79a

Browse files
committed
fix: griffe warnings
1 parent 8809719 commit e7ea79a

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

src/typed_diskcache/utils/deque.py

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,6 @@ class Deque(MutableSequence[_T], Generic[_T]):
3636
Items are serialized to disk. Deque may be initialized from directory path
3737
where items are stored.
3838
39-
Args:
40-
values: Values to initialize deque. Defaults to None.
41-
maxlen: Maximum length of deque. Defaults to None (infinite).
42-
directory: Directory path to store items. Defaults to None.
43-
**kwargs: additional keyword arguments for
44-
[`Settings`][typed_diskcache.model.Settings].
45-
4639
Examples:
4740
```python
4841
from typed_diskcache.utils.deque import Deque
@@ -83,6 +76,21 @@ def __init__(
8376
directory: str | PathLike[str] | None = None,
8477
**kwargs: Unpack[SettingsKwargs],
8578
) -> None:
79+
"""Persistent sequence with double-ended queue semantics.
80+
81+
Double-ended queue is an ordered collection with optimized access at its
82+
endpoints.
83+
84+
Items are serialized to disk. Deque may be initialized from directory path
85+
where items are stored.
86+
87+
Args:
88+
values: Values to initialize deque. Defaults to None.
89+
maxlen: Maximum length of deque. Defaults to None (infinite).
90+
directory: Directory path to store items. Defaults to None.
91+
**kwargs: additional keyword arguments for
92+
[`Settings`][typed_diskcache.model.Settings].
93+
"""
8694
eviction_policy = kwargs.pop("eviction_policy", EvictionPolicy.NONE)
8795
if eviction_policy != EvictionPolicy.NONE:
8896
warnings.warn(

0 commit comments

Comments
 (0)