diff options
| author | Darren Bane <darren.bane@emdalo.com> | 2021-01-18 09:57:31 +0000 |
|---|---|---|
| committer | Darren Bane <darren.bane@emdalo.com> | 2021-01-18 09:57:31 +0000 |
| commit | 31a933ffe1617cf912dea58b8bb856183f7668f1 (patch) | |
| tree | f8d40e324d62d4c0d45b749f87b7625b2f49898e /doc | |
| parent | 207cda23007f05dd954ee82511babba457465265 (diff) | |
| download | lsp-31a933ffe1617cf912dea58b8bb856183f7668f1.tar.gz | |
Commit local changes before pulling from upstream
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/breaking_rules.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/breaking_rules.md b/doc/breaking_rules.md index 0c34594..0eb3474 100644 --- a/doc/breaking_rules.md +++ b/doc/breaking_rules.md @@ -88,7 +88,7 @@ Even though this is a prototype, attention should be paid to basic craftsmanship * Divide the system into packages, using the subset of CL that is supported by OpenLisp -* Write one-sentence docstrings for at least each public fun and class +* Write one-sentence docstrings for at least each public fun, class, and package * Use `declare` to check the types of parameters in public interfaces (see below). * Indent all the source code using Emacs. @@ -194,7 +194,7 @@ But it's not worth writing custom rules. ### UI ltk is great for local GUIs. -However, a product may require HTMX and the platform.sh stack. +However, a product may (or may not) require HTMX and the platform.sh stack. Note that I prefer HTMX & ReST (following Fielding) to single-page applications (outside the very specific case of drawing on a canvas using ParenScript). |