search

IMTEK-Simulation / NuMPI

Utilities for MPI-parallel numerical calculations with Python
MIT License
2 stars 1 forks source link

Filename should not have underscores #2

Closed pastewka closed 5 years ago

pastewka commented 5 years ago

e.g. LBFGS_Matrix_H.py

Please follow pep-8. I added a document with contribution guidelines.

pastewka commented 5 years ago

Folding this into the cleanup issue...

mcrot commented 5 years ago

In pep-8 I find

Package and Module Names

Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability. Python packages should also have short, all-lowercase names, although the use of underscores is discouraged.

.. and LBFGS_Matrix_H.py is a module name. So as long the underscores improve readability, the infringement of PEP-8 here is more that it should be lowercase? Or do you refer to another rule I haven't found?

pastewka commented 5 years ago

Well - I'd say either CamelCase or underscores, not both.

There is an unwritten Python rule that basic libraries (sys, os, numpy, numpy.linalg, etc.) use small case for module names while dependent code uses CamelCase. (PyCo, PyCo.Topography). I would stick to this.

mcrot commented 5 years ago

Okay - I didn't know that.