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

unify spelling of Numpy/NumPy #7986

Closed
2 tasks
btel opened this issue Aug 29, 2016 · 6 comments
Closed
2 tasks

unify spelling of Numpy/NumPy #7986

btel opened this issue Aug 29, 2016 · 6 comments

Comments

@btel
Copy link
Contributor

btel commented Aug 29, 2016

The documentation is not consistent in spelling of "NumPy" (vs "Numpy"). For example, the reference manual uses both spelling in the introduction paragraph:

This reference manual details functions, modules, and objects included in Numpy, describing what they are and what they do. For learning how to use NumPy, see also :ref:user.

What is the official spelling? Make it consistent across all documentation.

This issue was initially reported at Scipy Lectures (scipy-lectures/scientific-python-lectures#250) by @btel and @emmanuelle.

Following the discussion on the mailing list and recommendations of @pdebuyl to close the issue:

  • update the docs to use NumPy when we refer to the project and numpy only in relation to the module name
  • explain the rules of "NumPy" spelling in the NumPy docs
@charris
Copy link
Member

charris commented Aug 29, 2016

The choice always leaves me thinking a bit. I try to use NumPy for official stuff, but tend to fall back on numpy for informal communication. This might be a good topic to raise on the mailing list.

@pdebuyl
Copy link
Contributor

pdebuyl commented Sep 5, 2016

The mailing-list thread has support for NumPy (uppercase N and P) from

The book by @teoliphant (still available here, for instance http://csc.ucdavis.edu/~chaos/courses/nlp/Software/NumPyBook.pdf) is "Guide to NumPy" and the intro is consistently using "NumPy".

There are inconsistencies in the documentation on scipy.org but I (humbly) suggest to pick "NumPy" for the name of the project and also for reference to the software and "numpy" as the module name. The "Guide to NumPy" refers to the numpy namespace.

There is no FAQ in the documentation of NumPy but it would be good to add this information somewhere (either in the NumPy reference or in the user guide).

"NumPy arrays" and "numpy arrays" can both be used, as they can refer to the project or to the module.

@btel
Copy link
Contributor Author

btel commented Sep 5, 2016

@pdebuyl thanks! I updated the issue with your proposed solution. If there is no other volunteers, I can open a PR with these changes.

@pdebuyl
Copy link
Contributor

pdebuyl commented Sep 5, 2016

I can help for this.

There are 61 files in numpy and 75 in doc.

$ cd numpy/
$ ack-grep -l Numpy | wc -l
61
$ cd ../doc/
$ ack-grep -l Numpy | wc -l
75

Should the release notes be modified? They could be considered "historical" data.

There are a few instances of "Numpy*" in the test code (the NumpyDoctest in nosetests), in the distutils code (NumpyDistribution class) and the NumpyVersion variable.

The C code seems to use "NumPy" consistently.

pdebuyl added a commit to pdebuyl/numpy that referenced this issue Sep 6, 2016
Instances remain for NumpyVersion and Numpy.rec.fromarrays that are
references to code.

Release notes were left unchanged.

see issue numpy#7986
@eric-wieser
Copy link
Member

@pdebuyl: Can this be closed, or is there more to do here?

@pdebuyl
Copy link
Contributor

pdebuyl commented Feb 19, 2017

No problem for closing. The corresponding PR was merged.

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

No branches or pull requests

4 participants