Skip to content

Enforce Google style docstrings with ruff #2027

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.

Sign up for GitHub

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

Merged
adamtheturtle merged 1 commit into from
Apr 19, 2024
Merged

Enforce Google style docstrings with ruff #2027

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,19 +210,9 @@ ignore = [
"COM812",
# Allow our chosen docstring line-style - no one-line summary.
"D200",
"D203",
"D205",
"D212",
"D213",
"D400",
"D415",
# It is too much work to make every docstring imperative.
"D401",
# We ignore some docstyle errors which do not apply to Google style
# docstrings.
"D406",
"D407",
"D413",
# Ruff warns that this conflicts with the formatter.
"ISC001",
# We have an existing interface to support and so we do not want to change
Expand All @@ -246,6 +236,9 @@ ignore = [
# is sometimes annoyingly removed.
unfixable = ["ERA001"]

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.ruff.lint.per-file-ignores]
"tests/**" = [
# Allow possible hardcoded passwords in tests.
Expand Down