docs: move D100-D300 to per-file-ignores, forbid rest-docstrings. - #1008
Draft
martynia wants to merge 2 commits into
Draft
docs: move D100-D300 to per-file-ignores, forbid rest-docstrings. #1008martynia wants to merge 2 commits into
martynia wants to merge 2 commits into
Conversation
aldbr
requested changes
Aug 18, 2026
| language: pygrep | ||
| entry: '^\s*:(param|type|returns?|rtype|raises?|ivar|cvar|vartype)\b' | ||
| types: [python] | ||
| exclude: "^(diracx-client/src/diracx/client|extensions/gubbins/gubbins-client/src/gubbins/client)/" |
Contributor
There was a problem hiding this comment.
What about?
Suggested change
| exclude: "^(diracx-client/src/diracx/client|extensions/gubbins/gubbins-client/src/gubbins/client)/" | |
| exclude: '/_generated/' |
Comment on lines
+89
to
+105
| "extensions/gubbins/gubbins-api/src/gubbins/api/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-api/tests/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-cli/src/gubbins/cli/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-cli/tests/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-client/src/gubbins/client/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-client/tests/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-core/src/gubbins/core/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-core/tests/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-db/src/gubbins/db/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-db/tests/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-logic/src/gubbins/logic/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-logic/tests/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-routers/src/gubbins/routers/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-routers/tests/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-tasks/src/gubbins/tasks/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-tasks/tests/**/*.py" = ["D100", "D101", "D102", "D103"] | ||
| "extensions/gubbins/gubbins-testing/src/gubbins/testing/**/*.py" = ["D100", "D101", "D102", "D103"] |
Contributor
There was a problem hiding this comment.
I am not fully sure this is going to work, I think these need to go in extensions/gubbins/pyproject.toml.
Btw, I just noticed that the following blocks should also be added there ideally:
[tool.ruff.lint.pydocstyle]
convention = "google"[tool.ruff.lint]
select = [
...
"D", # pydocstyle
DIRACGridBot
marked this pull request as draft
August 18, 2026 08:00
Contributor
|
Ideally, I would like to see at least one PR based on this one where you add the missing docstrings in a package (as you already did) and you remove the package from |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A minimal, "bootstrap" PR to address #1004