Documentation

An assortment of quick tips to help you make your technical documentation (docstrings, READMEs) easier to read.

Makefiles are convenient for semi-automating project tasks. We often use these files for running, building, and deploying projects. However, they often come without documentation.

This article explains how to print Makefile targets to the command line with help texts.

Sharing my philosophy and favorite tips and tricks on writing code documentation.