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

proposing new module structure #5

Open
d3netxer opened this issue Dec 13, 2019 · 3 comments
Open

proposing new module structure #5

d3netxer opened this issue Dec 13, 2019 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@d3netxer
Copy link
Contributor

  • for consistency just use lowercase and underscores for library names.
  • change name of GOSTnet.py to core.py
  • change init.py from:
from GOSTnets.GOSTnet import *

to

from .core import *
from .calculate_od import *
from .optimization import *
etc...

I am working on the Sphinx documentation now and the autodoc functionality. It is spitting out function names like "GOSTnets.GOSTnet.find_graph_avg_speed"; so this way should make the function names look nicer too.

@d3netxer d3netxer added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 13, 2019
@d3netxer
Copy link
Contributor Author

yes, I think for modules we can go with short, all-lowercase names, and they can contain underscores.

https://softwareengineering.stackexchange.com/questions/308972/python-file-naming-convention

@d3netxer
Copy link
Contributor Author

so I did this. One thing this does is want the extra underlying libraries to have their dependencies too. So we may want to continue thinking about this.

@d3netxer
Copy link
Contributor Author

Also, once this looks good, let's try to update the version on PiPy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant