commit c09138ad02dd56e09582fdd58aaab92f75d66531
parent 4b78434ea4ce0ed29bd56037613c0ef2471bb0ee
Author: Daniel Barlow <dan@telent.net>
Date: Tue, 17 Jan 2023 11:46:29 +0000
link to fennel-lang/style and explain the departures from it
Diffstat:
1 file changed, 11 insertions(+), 0 deletions(-)
diff --git a/doc/index.md b/doc/index.md
@@ -106,6 +106,17 @@ is the Super key. For me this matches how Emacs does it, but I would
welcome reports of machines/setups that don't act ths way
+## Fennel style
+
+https://fennel-lang.org/style is my style bible, although there are
+places I have departed from it. In particular, I have used CamelCase
+to name several modules which act as classes, so that I can
+distinguish `buffer` (an object which represents a buffer, and
+understands messages like `visit` or `name` or `location`) from
+`Buffer` (the factory which instantiates `buffer` objects). There is
+probably a nicer way to do this, but I haven't found it yet.
+
+
## Contributing
If you like (or see the potential in) Dunlin enough to want to
