git-hooks.nix icon indicating copy to clipboard operation
git-hooks.nix copied to clipboard

Add small comment to each file about purpose

Open blaggacao opened this issue 5 years ago • 0 comments

Knowing pre-commit a fair bit, bit not beeing a nix expert, I found it extremely hard to reason about the structure and inner workings of this tool.

Traditional grep technics to identify callers and callees where not always successful.

Mostly, this might be attributed to the "black magic" — cum grano salis — of callPackage.

A small comment about the nature of each file at the top, would probably have helped me find my way around, better.

Related to #2 & #32

blaggacao avatar Sep 04 '20 06:09 blaggacao