documentation

Things I Learnt The Hard Way - If A Function Description Includes An "And", It's Wrong

1 minute read Published: 2019-06-23

Functions should do one thing and one thing only. I clear indication that you're breaking this principle is the need to add an "and" in its documentation.

Things I Learnt The Hard Way - Good Languages Come With Integrated Documentation

1 minute read Published: 2019-06-23

If you're worried about learning some new programming language, you can bet the one with a better documentation is the one that is born with a document processor.

Same goes for the frameworks/libraries of that language.

Things I Learnt The Hard Way - The Function Documentation Is Its Contract

1 minute read Published: 2019-06-21

When you start the code by writing the general flow as steps and making each step a function, you're actually making a contract (probably with your future self): I'm saying this function does this and this is what it does.

Things I Learnt The Hard Way - Documentation Is a Love Letter To Your Future Self

1 minute read Published: 2019-06-21

We all know writing the damn docs for functions and classes and modules is a pain in the backside. But realizing what you were thinking when you wrote the function will save your butt in the future.