Skip to content

CI: pydocstyle>=5.1.0, flake8-docstrings>=1.4.0 verified to work#18780

Merged
QuLogic merged 1 commit into
matplotlib:masterfrom
brunobeltran:PR_template_flake8_latest
Oct 21, 2020
Merged

CI: pydocstyle>=5.1.0, flake8-docstrings>=1.4.0 verified to work#18780
QuLogic merged 1 commit into
matplotlib:masterfrom
brunobeltran:PR_template_flake8_latest

Conversation

@brunobeltran

@brunobeltran brunobeltran commented Oct 20, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

PR Summary

Our docs used to cause pydocstyle>4 to raise, so we had this instruction in the pull request template which appears to no longer be needed.

Tested locally in a new conda environment:

$ conda create -n doc_check python=3.8
$ conda activate doc_check
$ pip install flake8-docstrings
$ flake8 --docstring-convention=all lib/matplotlib  # no longer raises

PR Checklist

Old version:

  • Conforms to Matplotlib style conventions (install flake8-docstrings and pydocstyle<4 and run flake8 --docstring-convention=all).

New version:

  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).

@brunobeltran brunobeltran added this to the v3.4.0 milestone Oct 20, 2020
@timhoffm

timhoffm commented Oct 20, 2020

Copy link
Copy Markdown
Member

We should also update requirements/testing/flake8.txt (c.f. #18200). @brunobeltran can you give minimum required versions? - Probably pydocstyle>=5.1.0 because your docstring interpolation will need that anyway? It's good to remove that comment from the PR template but I'd like to have this specified in the requirements.

@brunobeltran brunobeltran force-pushed the PR_template_flake8_latest branch from 82b3e58 to baa303f Compare October 21, 2020 15:22
@brunobeltran brunobeltran force-pushed the PR_template_flake8_latest branch from baa303f to 8d8f801 Compare October 21, 2020 15:28
@brunobeltran brunobeltran changed the title DOC: upstream fix in pydocstyle simplifies instrutions CI: pydocstyle>=5.1.0, flake8-docstrings>=1.3.1 verified to work Oct 21, 2020
@brunobeltran

brunobeltran commented Oct 21, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

We should also update requirements/testing/flake8.txt (c.f. #18200). @brunobeltran can you give minimum required versions?

Yeah I was stupidly going to submit two micro-PRs, but just put it all here. I've verified locally that every combination of pydocstyle and flake8-docstrings versions greater than the ones specified here will run without errors locally.

They seem to be emitting different warnings on CI than locally, however, so I'll have to see what's up with that. Seems to be the same thing you say in #18200?

Edit: Nope, I'm just blind, just needed to mark a couple of false positives.

@brunobeltran brunobeltran marked this pull request as draft October 21, 2020 15:36
@brunobeltran brunobeltran force-pushed the PR_template_flake8_latest branch 3 times, most recently from 5239be2 to 76c1eea Compare October 21, 2020 16:11
@brunobeltran
CI: pydocstyle>=5.1.0, and update PR instructions
76c1eea 
New pydocstyle will always think a line with just "TODO" on it is a
title, and other minor changes to make sure CI passes.
@brunobeltran brunobeltran marked this pull request as ready for review October 21, 2020 16:12
@timhoffm timhoffm mentioned this pull request Oct 21, 2020
Closed
@brunobeltran brunobeltran changed the title CI: pydocstyle>=5.1.0, flake8-docstrings>=1.3.1 verified to work CI: pydocstyle>=5.1.0, flake8-docstrings>=1.4.0 verified to work Oct 21, 2020
@QuLogic QuLogic merged commit fda6398 into matplotlib:master Oct 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@QuLogic QuLogic QuLogic approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

Build Documentation Maintenance

Projects

None yet

Milestone

v3.4.0

Development

Successfully merging this pull request may close these issues.

3 participants

@brunobeltran @timhoffm @QuLogic