ubsuny / CP1-24-HW2

Homework2 template for CP1-24
1 stars 15 forks source link

Code explanation #25

Open Cosmos491 opened 1 month ago

Cosmos491 commented 1 month ago

Do I have to explain the code as well in the documentation section, or just the theory aspect of it?

iglesias-cardinale commented 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.

ojha-aditya commented 1 month ago

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.

p-pxmpo commented 1 month ago

I would also explain the code on the way using docstrings