diff options
author | Darren Bane <dbane@tilde.institute> | 2020-10-09 20:17:38 +0100 |
---|---|---|
committer | Darren Bane <dbane@tilde.institute> | 2020-10-09 20:17:38 +0100 |
commit | 08296c9356bd265eb2b077dfd3888488ea229b2a (patch) | |
tree | 3a4ef88d89f0381f49e771de580d028bb9dee038 /doc/breaking_rules.md | |
parent | 249656ed94a1ea851654951057e1f9ea0278f763 (diff) | |
download | lsp-08296c9356bd265eb2b077dfd3888488ea229b2a.tar.gz |
Minor doc tweaks
Diffstat (limited to 'doc/breaking_rules.md')
-rw-r--r-- | doc/breaking_rules.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/breaking_rules.md b/doc/breaking_rules.md index 38abe77..b8887b3 100644 --- a/doc/breaking_rules.md +++ b/doc/breaking_rules.md @@ -116,11 +116,15 @@ Even though this is a prototype, attention should be paid to basic craftsmanship \.[ preston-werner 2010 \.] -and man pages +and man (actually, mdoc) pages \.[ -collyer cox +dzonsons \.] . +* Certain parts of a system justify greater detail for a *complete* specification. + These are (newly-designed) network protocols and complex persistent data models. + If there is no standard protocol, I recommend using JSON-RPC as a base and following the documentation style of LSP. + The data models should be documented as commented SQL DDL. ### Run-time type-checking |