“My Code is Self-Documenting”

Re:“My Code is Self-Documenting” by x0x0 on Friday January 27, 2017 @05:07PM (#13503131)

So add comments to your code review process. This really isn't hard.

For example: python functions shall have a docstring unless trivial. For external api functions on a class, there must be at least one example. etc etc. Plus, this makes working in ipython really nice!

[ Parent | on HN ]

Re:“My Code is Self-Documenting” by emodendroket on Friday January 27, 2017 @08:39PM (#13504286)

I usually apply something like this except only for public methods; I figure if you're digging around the private methods you probably need to look closely anyways.

[ Parent | on HN ]