Which NumPy/Numpy/numpy spelling?
Hi all,
What is the official spelling of NumPy/Numpy/numpy?
The documentation is not consistent and it mixes both NumPy and Numpy. For example, the reference manual uses both spellings in the introduction paragraph (http://docs.scipy.org/doc/numpy/reference/):
"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 NumPy User Guide."
However, in all docs taken together "NumPy" is most frequently used (74%):
% find . -name "*.rst" -exec grep Numpy -ow {} ; | wc -l 161 % find . -name "*.rst" -exec grep NumPy -ow {} ; | wc -l 471
I also reported it as an issue: https://github.com/numpy/numpy/issues/7986
Yours,
Bartosz
On 08/29/2016 07:43 AM, mail@telenczuk.pl wrote:
What is the official spelling of NumPy/Numpy/numpy?
IMHO it should be written numpy, because ...
import NumPy
Traceback (most recent call last): File "<stdin>", line 1, in <module> ImportError: No module named NumPy
import Numpy
Traceback (most recent call last): File "<stdin>", line 1, in <module> ImportError: No module named Numpy
import numpy
Phil
Hi,
I would not mind any choice as long as it's consistent.
I agree that using all-lowercase spelling may avoid some common errors. However, PEP8 requires all module/package names to be lower case [1]. If we force the name of the library and the corresponding package to be the same, all Python libraries would be named in lowercase. This would not be the best choice for libraries, which have multi-component names (like NumPy = Numerical Python).
Note also that both the Wikipedia page [2] and the official NumPy logo [3] use "NumPy" spelling.
Some other popular [4] libraries use similar dichotomies:
- Django - import django - Cython - import cython - PyYAML - import yaml - scikit-learn - import sklearn
On the other hand all standard Python libraries are lower-case named.
Cheers,
Bartosz
[1] https://www.python.org/dev/peps/pep-0008/#package-and-module-names [2] https://en.wikipedia.org/wiki/NumPy [3] http://www.numpy.org/_static/numpy_logo.png [4] http://pypi-ranking.info/alltime
On 08/29/2016 07:43 AM, mail@telenczuk.pl wrote:
What is the official spelling of NumPy/Numpy/numpy?
IMHO it should be written numpy, because ...
import NumPy
Traceback (most recent call last): File "<stdin>", line 1, in <module> ImportError: No module named NumPy
import Numpy
Traceback (most recent call last): File "<stdin>", line 1, in <module> ImportError: No module named Numpy
import numpy
Phil _______________________________________________ NumPy-Discussion mailing list NumPy-Discussion@scipy.org https://mail.scipy.org/mailman/listinfo/numpy-discussion
https://mail.scipy.org/pipermail/scipy-user/2010-June/025756.html
"NumPy and SciPy to refer to the projects. numpy and scipy to refer to the packages, specifically. When in doubt, use the former."
I thought there was also another discussion about capital letters, but I don't find it.
Josef
On Mon, Aug 29, 2016 at 9:22 AM, Bartosz Telenczuk mail@telenczuk.pl wrote:
Hi,
I would not mind any choice as long as it's consistent.
I agree that using all-lowercase spelling may avoid some common errors. However, PEP8 requires all module/package names to be lower case [1]. If we force the name of the library and the corresponding package to be the same, all Python libraries would be named in lowercase. This would not be the best choice for libraries, which have multi-component names (like NumPy = Numerical Python).
Note also that both the Wikipedia page [2] and the official NumPy logo [3] use "NumPy" spelling.
Some other popular [4] libraries use similar dichotomies:
- Django - import django
- Cython - import cython
- PyYAML - import yaml
- scikit-learn - import sklearn
On the other hand all standard Python libraries are lower-case named.
Cheers,
Bartosz
[1] https://www.python.org/dev/peps/pep-0008/#package-and-module-names [2] https://en.wikipedia.org/wiki/NumPy [3] http://www.numpy.org/_static/numpy_logo.png [4] http://pypi-ranking.info/alltime
On 08/29/2016 07:43 AM, mail@telenczuk.pl wrote:
What is the official spelling of NumPy/Numpy/numpy?
IMHO it should be written numpy, because ...
import NumPy
Traceback (most recent call last): File "<stdin>", line 1, in <module> ImportError: No module named NumPy
import Numpy
Traceback (most recent call last): File "<stdin>", line 1, in <module> ImportError: No module named Numpy
import numpy
Phil _______________________________________________ NumPy-Discussion mailing list NumPy-Discussion@scipy.org https://mail.scipy.org/mailman/listinfo/numpy-discussion
NumPy-Discussion mailing list NumPy-Discussion@scipy.org https://mail.scipy.org/mailman/listinfo/numpy-discussion
There was similar discussion almost two years ago with respect to capitalization of matplotlib in prose. Most of the time, it was lower-case in our documentation, but then the question was if it should be upper-case at the beginning of the sentence... or should it always be upper-cased like a proper noun. I don't think a clear consensus was reached, but I ended up treating it as a proper noun in my book.
I am also pretty sure I used "NumPy" in most places, even for "NumPy arrays", which still looks weird to me when I go back over my book.
Ben Root
On Mon, Aug 29, 2016 at 12:56 PM, josef.pktd@gmail.com wrote:
https://mail.scipy.org/pipermail/scipy-user/2010-June/025756.html
"NumPy and SciPy to refer to the projects. numpy and scipy to refer to the packages, specifically. When in doubt, use the former."
I thought there was also another discussion about capital letters, but I don't find it.
Josef
On Mon, Aug 29, 2016 at 9:22 AM, Bartosz Telenczuk mail@telenczuk.pl wrote:
Hi,
I would not mind any choice as long as it's consistent.
I agree that using all-lowercase spelling may avoid some common errors.
However,
PEP8 requires all module/package names to be lower case [1]. If we
force the
name of the library and the corresponding package to be the same, all
Python
libraries would be named in lowercase. This would not be the best choice
for
libraries, which have multi-component names (like NumPy = Numerical
Python).
Note also that both the Wikipedia page [2] and the official NumPy logo
[3] use
"NumPy" spelling.
Some other popular [4] libraries use similar dichotomies:
- Django - import django
- Cython - import cython
- PyYAML - import yaml
- scikit-learn - import sklearn
On the other hand all standard Python libraries are lower-case named.
Cheers,
Bartosz
[1] https://www.python.org/dev/peps/pep-0008/#package-and-module-names [2] https://en.wikipedia.org/wiki/NumPy [3] http://www.numpy.org/_static/numpy_logo.png [4] http://pypi-ranking.info/alltime
On 08/29/2016 07:43 AM, mail@telenczuk.pl wrote:
What is the official spelling of NumPy/Numpy/numpy?
IMHO it should be written numpy, because ...
import NumPy
Traceback (most recent call last): File "<stdin>", line 1, in <module> ImportError: No module named NumPy
import Numpy
Traceback (most recent call last): File "<stdin>", line 1, in <module> ImportError: No module named Numpy
import numpy
Phil _______________________________________________ NumPy-Discussion mailing list NumPy-Discussion@scipy.org https://mail.scipy.org/mailman/listinfo/numpy-discussion
NumPy-Discussion mailing list NumPy-Discussion@scipy.org https://mail.scipy.org/mailman/listinfo/numpy-discussion
NumPy-Discussion mailing list NumPy-Discussion@scipy.org https://mail.scipy.org/mailman/listinfo/numpy-discussion
On Mon, Aug 29, 2016, at 04:43, mail@telenczuk.pl wrote:
The documentation is not consistent and it mixes both NumPy and Numpy. For example, the reference manual uses both spellings in the introduction paragraph (http://docs.scipy.org/doc/numpy/reference/):
"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 NumPy User Guide."
That's technically a bug: the official spelling is NumPy. But, no one really cares :)
Stéfan
On Di, 2016-08-30 at 12:17 -0700, Stefan van der Walt wrote:
On Mon, Aug 29, 2016, at 04:43, mail@telenczuk.pl wrote:
The documentation is not consistent and it mixes both NumPy and Numpy. For example, the reference manual uses both spellings in the introduction paragraph (http://docs.scipy.org/doc/numpy/reference/):
"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 NumPy User Guide."
That's technically a bug: the official spelling is NumPy. But, no one really cares :)
I like the fact that this is all posted in: [Numpy-discussion] ;).
- Sebastian
Stéfan
NumPy-Discussion mailing list NumPy-Discussion@scipy.org https://mail.scipy.org/mailman/listinfo/numpy-discussion
Hi,
The general consensus seems to be in favour of using "NumPy" when referring to the project and "numpy" as a module name.
Please note that there are currently PRs in 3 different repositories implementing this practice:
- numpy docs: https://github.com/numpy/numpy/pull/8021 - numpy.org website: https://github.com/numpy/numpy.org/pull/5 - Scipy Lecture Notes: https://github.com/scipy-lectures/scipy-lecture-notes/pull/265
The name of the mailing lists still conflicts with the practice, but perhaps it would be more hassle to rename it than it's worth it. :). There is also some instances of "Numpy" spelling in numpy sources, but changing them would probably need more care and time.
If everyone agrees the PRs could be merged together. Please review and comment!
Thanks in advance,
Bartosz
On 6 Sep 2016, at 8:05 PM, Bartosz Telenczuk mail@telenczuk.pl wrote:
The name of the mailing lists still conflicts with the practice, but perhaps it would be more hassle to rename it than it's worth it. :)
The footer appended by the mailing list shows that the name it’s right but only the subject tag is wrong. It’s trivial to fix.
NumPy-Discussion mailing list NumPy-Discussion@scipy.org https://mail.scipy.org/mailman/listinfo/numpy-discussion
Best wishes, Andrea
-- Andrea Bedini @andreabedini, http://www.andreabedini.com
See the impact of my research at https://impactstory.org/AndreaBedini use https://keybase.io/andreabedini to send me encrypted messages Key fingerprint = 17D5 FB49 FA18 A068 CF53 C5C2 9503 64C1 B2D5 9591
participants (8)
-
Andrea Bedini -
Bartosz Telenczuk -
Benjamin Root -
josef.pktd＠gmail.com -
mail＠telenczuk.pl
-
Phil Hodge -
Sebastian Berg -
Stefan van der Walt