Open Cosmos491 opened 1 month ago
In my understanding it's generally a good idea to document your code using comments or docstrings so that somebody just looking at the code for the first time can understand what's going on and how it all works.
There is also a possible way to write the documentation and code together in respective markdown and code cells in Jupyter notebooks but as mentioned in class, won't be wise for tremendously large projects.
I would also explain the code on the way using docstrings
Do I have to explain the code as well in the documentation section, or just the theory aspect of it?