Documentation
¶
Overview ¶
Command prose collects the text anfra's Go code writes for its users to read into review tables: a folder per kind of text (errors, descriptions, help and other), and in it a YAML file per area of the code, of at most a review batch each. It's the extraction step of docs/todos/improve-proses.md.
go run ./scripts/prose [-force]
It writes into tmp/prose/, which git ignores: the tables are worked on and reviewed locally, not committed. It refuses to replace a kind's folder that's already there, since its entries may hold triage and rewrites: -force replaces it.
It parses the code rather than grepping it, so it joins "a" + "b", knows which field or call a string is in, and skips tests. A string found in several places is one entry, listing each.