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

merged 20 commits into from
Jan 4, 2024

Commits on Dec 27, 2023

  1. Enable ruff's pydocstyle (D) rules and set numpy convention

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    b9c4d42 View commit details
    Browse the repository at this point in the history

  2. Fix D406: Section name should end with a newline ('Notes')

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    fa93c37 View commit details
    Browse the repository at this point in the history

  3. Fix D405L: Section name should be properly capitalized ('See also')

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    092075a View commit details
    Browse the repository at this point in the history

  4. Fix D104 Missing docstring in public package

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    608f38d View commit details
    Browse the repository at this point in the history

  5. Fix D409: Section underline should match the length of its name

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    0f9cb0b View commit details
    Browse the repository at this point in the history

  6. Ignore a D410/D411 violation

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    d9116bd View commit details
    Browse the repository at this point in the history

  7. Fix D103: Missing docstring in public function

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    f22bfa0 View commit details
    Browse the repository at this point in the history

  8. Fix D105: Missing docstring in magic method

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    1280a1c View commit details
    Browse the repository at this point in the history

  9. Fix a formatting issue

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    b5a4353 View commit details
    Browse the repository at this point in the history

  10. Ignore some D rules 

    ```
$ 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)
```
    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    3170401 View commit details
    Browse the repository at this point in the history

  11. Enabel D213 and D410 rules

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    5d983e6 View commit details
    Browse the repository at this point in the history

  12. Fully remove docformatter

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    435290f View commit details
    Browse the repository at this point in the history

  13. Update the contributing guides

    @seisman
    seisman committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    6e04543 View commit details
    Browse the repository at this point in the history

Commits on Jan 1, 2024

  1. Merge branch 'main' into ruff/pydocstyle

    @seisman
    seisman committed Jan 1, 2024
    Configuration menu
    Copy the full SHA
    e834989 View commit details
    Browse the repository at this point in the history

Commits on Jan 2, 2024

  1. Merge branch 'main' into ruff/pydocstyle

    @seisman
    seisman committed Jan 2, 2024
    Configuration menu
    Copy the full SHA
    9cebfc8 View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into ruff/pydocstyle

    @seisman
    seisman committed Jan 2, 2024
    Configuration menu
    Copy the full SHA
    3e91925 View commit details
    Browse the repository at this point in the history

Commits on Jan 3, 2024

  1. Merge branch 'main' into ruff/pydocstyle

    @seisman
    seisman committed Jan 3, 2024
    Configuration menu
    Copy the full SHA
    2cf7e19 View commit details
    Browse the repository at this point in the history

  2. Update pygmt/src/config.py 

    Co-authored-by: Wei Ji <[email protected]>
    @seisman @weiji14
    seisman and weiji14 committed Jan 3, 2024
    Configuration menu
    Copy the full SHA
    ecd4a5d View commit details
    Browse the repository at this point in the history

  3. Merge branch 'main' into ruff/pydocstyle

    @seisman
    seisman committed Jan 3, 2024
    Configuration menu
    Copy the full SHA
    1e9a27c View commit details
    Browse the repository at this point in the history

  4. Order rules alphabetically

    @seisman
    seisman committed Jan 3, 2024
    Configuration menu
    Copy the full SHA
    3c41c8b View commit details
    Browse the repository at this point in the history