python-cachier / cachier

Persistent, stale-free, local and cross-machine caching for Python functions.
MIT License
534 stars 60 forks source link

lint: enable Ruff's D ~ `pydocstyle` #221

Closed Borda closed 3 months ago

Borda commented 3 months ago

complementary but still independent addition to #220 Note that the docs still needed to be checked so we could start with some ignored rules marked for todo and ask the community to help fix them...

Borda commented 3 months ago

remaining issues to be resolved:


cachier/__init__.py:1:1: D104 Missing docstring in public package
cachier/__main__.py:10:5: D401 First line of docstring should be in imperative mood: "A command-line interface for cachier."
cachier/config.py:1:1: D100 Missing docstring in public module
cachier/config.py:19:7: D101 Missing docstring in public class
cachier/core.py:108:5: D417 Missing argument description in the docstring for `cachier`: `hash_params`
cachier/core.py:121:5: D401 First line of docstring should be in imperative mood: "A persistent, stale-free memoization decorator."
cachier/core.py:304:13: D417 Missing argument descriptions in the docstring for `_precache_value`: `**kwds`, `*args`
cachier/cores/__init__.py:1:1: D104 Missing docstring in public package
cachier/cores/base.py:18:7: D101 Missing docstring in public class
cachier/cores/base.py:99:9: D205 1 blank line required between summary line and description
cachier/cores/pickle.py:65:13: D401 First line of docstring should be in imperative mood: "A Watchdog Event Handler method."
cachier/cores/pickle.py:69:13: D401 First line of docstring should be in imperative mood: "A Watchdog Event Handler method
Borda commented 3 months ago

@shaypal5 seems to be ready for landing...