Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lint: enable Ruff's D ~ pydocstyle #221

Merged
merged 6 commits into from
May 18, 2024
Merged

lint: enable Ruff's D ~ pydocstyle #221

merged 6 commits into from
May 18, 2024

Conversation

Borda
Copy link
Contributor

@Borda Borda commented May 15, 2024

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 Borda changed the title lint: enable Ruff's D -> pydocstyle lint: enable Ruff's D ~ pydocstyle May 15, 2024
@Borda Borda mentioned this pull request May 15, 2024
@Borda
Copy link
Contributor Author

Borda commented May 15, 2024

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 Borda marked this pull request as ready for review May 18, 2024 08:57
@Borda Borda requested a review from shaypal5 as a code owner May 18, 2024 08:57
@Borda
Copy link
Contributor Author

Borda commented May 18, 2024

@shaypal5 seems to be ready for landing...

@shaypal5 shaypal5 merged commit 8991cb1 into master May 18, 2024
33 checks passed
@shaypal5 shaypal5 deleted the ruff/D branch May 18, 2024 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants