It's worth looking at the runtime documentation generated from the docstrings of the various functions and packages. From a quick look I've noticed the following:
- No doctoring in
pyDis/__init__.py. Adding a docstring the top of this file would make help(pyDis) work. It need not be long. Just some text from the README file would probably do the job.
- Add a word or to in docstrings to
pyDis/pn/__init__.py and pyDis/atomic/__init__.py too. These can be really short.
- From a quick and non-exhaustive look most of the rest of the function docstrings look fine to me.
- Sometimes docstrings are missing from the top of modules.
- Once you have chosen a license note this and add a one line copyright statement in the docstring at the top of each module. You don't need the full license text.
I'll add any other specific points below.
It's worth looking at the runtime documentation generated from the docstrings of the various functions and packages. From a quick look I've noticed the following:
pyDis/__init__.py. Adding a docstring the top of this file would makehelp(pyDis)work. It need not be long. Just some text from the README file would probably do the job.pyDis/pn/__init__.pyandpyDis/atomic/__init__.pytoo. These can be really short.I'll add any other specific points below.