mmcloughlin / ec3

Elliptic Curve Cryptography Compiler: an incomplete experiment in code-generation for elliptic curves in Go
BSD 3-Clause "New" or "Revised" License
56 stars 6 forks source link

doc: one sentence description for every package #39

Open mmcloughlin opened 5 years ago

mmcloughlin commented 5 years ago

Every package should have a one-liner package-level docstring.

Consider linting for it too.

https://github.com/mmcloughlin/avo/blob/cad456ebdea789b868f5ef4e2da867fe0af0521e/script/linter/pkgdoc