Enable ruff's pydocstyle (D) rules and remove docformatter #2925
Conversation
This file contains 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
```
$ ruff check pygmt doc/conf.py examples --statistics
645 D200 [*] One-line docstring should fit on one line
312 D205 [ ] 1 blank line required between summary line and description
123 D400 [ ] First line should end with a period
30 D401 [ ] First line of docstring should be in imperative mood: "A mock GMT API function that always returns a given value."
30 D412 [*] No blank lines allowed between a section header and its content ("Examples")
12 D202 [*] No blank lines allowed after function docstring (found 1)
```
weiji14
reviewed
Jan 3, 2024
| @@ -445,7 +445,7 @@ def fmt_docstring(module_func): | |||
| - J = projection | |||
| - R = region | |||
| <BLANKLINE> | |||
| """ | |||
| """ # noqa: D410,D411 | |||
There was a problem hiding this comment.
Actually, this line is required. If removing noqa: D410, D411, the codes will be formatted with the following diff:
diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py
index 57bd0f900..b44dd7fec 100644
--- a/pygmt/helpers/decorators.py
+++ b/pygmt/helpers/decorators.py
@@ -425,6 +425,7 @@ def fmt_docstring(module_func):
<BLANKLINE>
My nice module.
<BLANKLINE>
+
Parameters
----------
data : str, numpy.ndarray, pandas.DataFrame, xarray.Dataset, or geo...
@@ -445,7 +446,7 @@ def fmt_docstring(module_func):
- J = projection
- R = region
<BLANKLINE>
- """ # noqa: D410,D411
+ """
filler_text = {}
if hasattr(module_func, "aliases"):Then the doctest fails, because only one blank line is expected, but two blank lines are given (one is <BLANKLINE>, another one is the newly added blank line).
There was a problem hiding this comment.
We could just remove the Oh wait, doesn't seem to work, hold on.<BLANKLINE> from L427 no?
There was a problem hiding this comment.
Yeah, looks like we'll need to keep it, since doctest takes an empty line to mean the end of the expected output according to https://docs.python.org/3/library/doctest.html#how-are-docstring-examples-recognized
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Better to review the commits one by one to understand the changes.
In b9c4d42, we enable ruff's pydocstyle (D) rules and set the docstring convention to "numpy".
After setting the "numpy" convention, we have to fix/ignore some violations (done in fa93c37, 092075a, 608f38d, 0f9cb0b, d9116bd, f22bfa0, 1280a1c).
After the above fixes, we still have hundreds of violations against 6 rules, as shown below:
D200: This is against our current style, so it must be disabled.In commit 3170401, these 6 rules are disabled.
As the documentation says (https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings):
Among these rules,
D213andD410make sense to the project and are enabled in commit 5d983e6.Then docformatter can be fully replaced by ruff and is removed in commit 435290f. The contributing guides are updated in 6e04543.
Please also note that, in the old settings, docformatter wraps docstrings at 79 characters. If we change the docformatting settings to 88, then the summary lines can be automatically rewrapped to 88 characters, as mentioned in #962 (comment). However, ruff's pydocstyle rules can't wrap long lines and only raise warnings. So, ruff is not as powerful as docformatter. In other words, we may want to change docformatter line-length settings to 88 (as done in #962 (comment)) and let docformatter rewrap lines to 88 characters before completely removing it (Done in #2926).
Closes #962.