Skip to content

DOC: capitalize NumPy as proper noun #38631

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
Dec 22, 2020

Conversation

erictleung
Copy link
Contributor

In a similar vein to #37808

  • closes #xxxx
  • tests added / passed
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

@jreback
Copy link
Contributor

jreback commented Dec 22, 2020

is it possible to modify the docs checkers to make sure this in enforced?

@jreback jreback added the Docs label Dec 22, 2020
@erictleung
Copy link
Contributor Author

We could add a spelling checker when building Sphinx https://sphinxcontrib-spelling.readthedocs.io/en/latest/index.html. I don't see this extension used in the current conf.py file (https://github.com/pandas-dev/pandas/blob/master/doc/source/conf.py#L52-L69). But of course, this would add to the number of dependencies, which may or may not be wanted.

If there's another place you're referring to, @jreback, I'd be interested to learn.

@jreback
Copy link
Contributor

jreback commented Dec 22, 2020

i think this needs to be a pre-commit hook or maybe we discussed as a code_check. cc @MarcoGorelli

can do later for that i guess.

@MarcoGorelli
Copy link
Member

I think a pygrep hook to check that we don't use Numpy (with only the N capitalised) would be OK - @erictleung if you check the other local pygrep hooks in .pre-commit-config.yaml they can provide a guide, feel free to reach out to me for help (here or on the gitter channel) if you want to do this and need help

@jreback jreback added this to the 1.3 milestone Dec 22, 2020
@jreback jreback merged commit 5a172c5 into pandas-dev:master Dec 22, 2020
@jreback
Copy link
Contributor

jreback commented Dec 22, 2020

thanks @erictleung

@erictleung erictleung deleted the format-numpy-capitalization branch December 22, 2020 20:51
luckyvs1 pushed a commit to luckyvs1/pandas that referenced this pull request Jan 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants