Skip to content

Upgrade pygrep, use in-built rst-directive-colons #37440

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

Merged
merged 1 commit into from
Oct 27, 2020

Conversation

MarcoGorelli
Copy link
Member

I got a PR in to pre-commit/pygrep-hooks to make the "incorrect-sphinx-directives" hook a built-in one (as it's not specific to pandas) 🎉 So, let's use it?

They also have another useful hook (rst-inline-touching-normal), which caught a couple of errors which I've fixed below.

The reason why I've kept rst-backticks to just rst files (as opposed to types: [text] like the other two) is that in docstrings, the numpy guide instructs to use single backticks for variable (though if it was ever desirable to change that, then this hook would make it pretty easy to check for consistency)

@simonjayhawkins simonjayhawkins added CI Continuous Integration Code Style Code style, linting, code_checks labels Oct 27, 2020
@simonjayhawkins simonjayhawkins added this to the 1.2 milestone Oct 27, 2020
@jreback jreback merged commit fabf03a into pandas-dev:master Oct 27, 2020
@jreback
Copy link
Contributor

jreback commented Oct 27, 2020

great thanks @MarcoGorelli very nice!

@MarcoGorelli MarcoGorelli deleted the upgrade-pygrep branch October 27, 2020 13:28
kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
ukarroum pushed a commit to ukarroum/pandas that referenced this pull request Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Code Style Code style, linting, code_checks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants