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.

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

Remove pinning of pydocstyle #2230

Closed

Conversation

MarkusPiotrowski
Copy link
Contributor

With the recent update of flake8-docstring, pinning of pydocstyle to versions < 4.0.0 should no longer be necessary (https://gitlab.com/pycqa/flake8-docstrings/issues/36).

  • I hereby agree to dual licence this and any previous contributions under both
    the Biopython License Agreement AND the BSD 3-Clause License.

  • I have read the CONTRIBUTING.rst file, have run flake8 locally, and
    understand that AppVeyor and TravisCI will be used to confirm the Biopython unit
    tests and style checks pass with these changes.

  • I have added my name to the alphabetical contributors listings in the files
    NEWS.rst and CONTRIB.rst as part of this pull request, am listed
    already, or do not wish to be listed. (This acknowledgement is optional.)

Copy link
Member

@peterjc peterjc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming the tests pass, this looks good.

@MarkusPiotrowski
Copy link
Contributor Author

MarkusPiotrowski commented Aug 26, 2019

There are now numerous D413 (missing blank line after last section) and some D412 (no blank lines allowed between a section header and its content) issues now. Need to investigate.
A quick inspection let suggest that D413 is reported if the docstring ends with single line 'section'.

@peterjc
Copy link
Member

peterjc commented Aug 26, 2019

D413 is strange, we fixed them back on #1192 - but evidentally pydocstyle have tweaked the rules.

@MarkusPiotrowski
Copy link
Contributor Author

MarkusPiotrowski commented Aug 27, 2019

Reported as issue at PyCQA/pydocstyle#401 (comment).

If we update to pydocstyle versions >3.0.0 we need to (temporarily) ignore D413 and D412, either until pydocstyle changes it rules or until we have solved all these 'issues'.

@peterjc
Copy link
Member

peterjc commented Aug 29, 2019

I think sticking with the older pydocstyle makes sense, pending some comments on that bug you kindly filed.

@peterjc
Copy link
Member

peterjc commented Dec 18, 2019

It seems the D413 false positives are fixed in pydocstyle v5 released earlier this month.

We could remove the pinning (as in the original change on #2230), but we now know that v4 does not work for us. Therefore #2414 changes this to require at least v5.

@peterjc
Copy link
Member

peterjc commented Dec 20, 2019

Superseded by #2414

@peterjc peterjc closed this Dec 20, 2019
@MarkusPiotrowski MarkusPiotrowski deleted the travis_tox branch December 21, 2019 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants