Closed andersgs closed 5 years ago
You comment at the end of bohra.py
about the name would ideally be in a docstring, for instance. :)
I see that many of the functions/class methods in the other modules have some docstrings. Nicely done!!
Ok, working on it!
Done
Add some docstrings to the top of these two files (at least, I would like to see it in all of them). That will help in self-documenting later. Ideally, all functions and class definitions would have one too. They don't have to be long. I generally try to start every function/class definition by writing down the docstrings what the element will do, and then what parameters it will take and what output to expect. That helps in organising things, and you can quickly see if the function is trying to do too much.
You can follow the sphinx model and then add sphinx to the
tasks.py
to automatically generate some docs too. https://pythonhosted.org/an_example_pypi_project/sphinx.html