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.

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

Jump to bottom

Enable ruff's pydocstyle (D) rules and remove docformatter #2925

Merged
merged 20 commits into from
Jan 4, 2024
Merged

Enable ruff's pydocstyle (D) rules and remove docformatter #2925

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
b9c4d42
Enable ruff's pydocstyle (D) rules and set numpy convention
seisman Dec 27, 2023
fa93c37
Fix D406: Section name should end with a newline ('Notes')
seisman Dec 27, 2023
092075a
Fix D405L: Section name should be properly capitalized ('See also')
seisman Dec 27, 2023
608f38d
Fix D104 Missing docstring in public package
seisman Dec 27, 2023
0f9cb0b
Fix D409: Section underline should match the length of its name
seisman Dec 27, 2023
d9116bd
Ignore a D410/D411 violation
seisman Dec 27, 2023
f22bfa0
Fix D103: Missing docstring in public function
seisman Dec 27, 2023
1280a1c
Fix D105: Missing docstring in magic method
seisman Dec 27, 2023
b5a4353
Fix a formatting issue
seisman Dec 27, 2023
3170401
Ignore some D rules
seisman Dec 27, 2023
5d983e6
Enabel D213 and D410 rules
seisman Dec 27, 2023
435290f
Fully remove docformatter
seisman Dec 27, 2023
6e04543
Update the contributing guides
seisman Dec 27, 2023
e834989
Merge branch 'main' into ruff/pydocstyle
seisman Jan 1, 2024
9cebfc8
Merge branch 'main' into ruff/pydocstyle
seisman Jan 2, 2024
3e91925
Merge branch 'main' into ruff/pydocstyle
seisman Jan 2, 2024
2cf7e19
Merge branch 'main' into ruff/pydocstyle
seisman Jan 3, 2024
ecd4a5d
Update pygmt/src/config.py
seisman Jan 3, 2024
1e9a27c
Merge branch 'main' into ruff/pydocstyle
seisman Jan 3, 2024
3c41c8b
Order rules alphabetically
seisman Jan 3, 2024
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
Prev Previous commit
Next Next commit
Enabel D213 and D410 rules
  • Loading branch information
@seisman
seisman committed Dec 27, 2023
commit 5d983e633bffe46b324fc55f2c4ebf7880f7d3d2
6 changes: 6 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@ select = [
"W", # pycodestyle warnings
"YTT", # flake8-2020
]
extend-select = [
"D213", # Summary lines should be positioned on the second physical line of the docstring.
"D410", # A blank line after section headings.
]
ignore = [
"D200", # One-line docstring should fit on one line
"D205", # 1 blank line required between summary line and description
Expand Down Expand Up @@ -161,6 +165,8 @@ known-third-party = ["pygmt"]
max-doc-length = 88

[tool.ruff.lint.pydocstyle]
# See https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings
# for the enabled/disabled rules for the "numpy" convention.
convention = "numpy"

[tool.ruff.lint.pylint]
Expand Down