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

Package and Module names should be lower case #86

Closed
1 task done
nick-falco opened this issue Jul 19, 2017 · 3 comments
Closed
1 task done

Package and Module names should be lower case #86

nick-falco opened this issue Jul 19, 2017 · 3 comments
Assignees

Comments

@nick-falco
Copy link
Collaborator

nick-falco commented Jul 19, 2017

A lot of the modules in the PH5 project contain upper case letters. These should be changed to all lower case.

The PEP8 Style Guideline states the following regarding module and package 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.

When an extension module written in C or C++ has an accompanying Python module that provides a higher level (e.g. more object oriented) interface, the C/C++ module has a leading underscore (e.g. _socket).

TODO:

  • Change all module and package names to all lower case.
@nick-falco
Copy link
Collaborator Author

Additionally, the "PH5View" package should be changed to "ph5view".

@derick-hess
Copy link
Contributor

working on it now.

@nick-falco
Copy link
Collaborator Author

Cool. In addition to updating all related imports to reflect the new file names, the entry_points in setup.py will have to be updated as well.

nick-falco pushed a commit that referenced this issue Jul 19, 2017
Fixed package, module, and class names according to PEP8.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants