diff options
| -rw-r--r-- | doc/breaking_rules.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/breaking_rules.md b/doc/breaking_rules.md index 947ca80..a31a0a1 100644 --- a/doc/breaking_rules.md +++ b/doc/breaking_rules.md @@ -132,7 +132,7 @@ Ensure that the surrounding infrastructure is in place: * Configuration management. The prototype should already have been checked into git. * Build. Split sections into different files, write simple Makefile. - *TODO*: copy elisp public/private convention? + In the absence of a standard module system, the elisp public/private convention can be copied. * Test. Write *library/test.lsp* test cases. @@ -142,14 +142,14 @@ Ensure that the surrounding infrastructure is in place: Then, the following code & documentation improvements should be made: * Document the system more exhaustively -* Can re-implement interfaces from the OpenLisp manual using UNIX libraries. +* Can re-implement more interfaces from the OpenLisp manual using UNIX libraries. * Can port any of the `trivial-*` libraries from quicklisp. * Maybe multi-process to take advantage of all cores Since we have a working prototype, it may make sense to write the documentation (and contracts, and tests) "bottom-up": -1. Contracts, static analysis +1. Contracts 2. Test cases 3. Module interface specs 4. Module guide, uses hierarchy @@ -161,7 +161,7 @@ it may make sense to write the documentation (and contracts, and tests) "bottom- Depend only on GFM, in the same spirit as the software. The use of tools like -nw2md and Pandoc should be minised. +nw2md and Pandoc should be minimised. PlantUML *should* be used where it can replace ad-hoc text. Documents should be stored under git in a "doc" subdirectory of the project. @@ -205,7 +205,7 @@ I'm not aware of any static analysis tool. For productisation you may want to add more features. -OpenLisp has idiomatic interfaces for several UNIX features in its manual, which could be re-implemented. +OpenLisp has idiomatic interfaces for several more UNIX features in its manual, which could be re-implemented. Also quicklisp (and as a second choice non-quicklisp) `trivial-*` libraries should be easy enough to port. Dependencies should be limited to these two initially. |