aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authormarty hiatt <martianhiatus [a t] riseup [d o t] net>2023-01-13 12:17:59 +0100
committermarty hiatt <martianhiatus [a t] riseup [d o t] net>2023-01-13 12:52:04 +0100
commite232e078bd1e26cb770519d7ce9c00c547fded7e (patch)
tree12c4922b7ada3f86bae8604c7f867766b7880832 /README.org
parent6c5d9b39abc9ec5b1d8d5fd93bf13b079c523e18 (diff)
readme: coding style pointers
Diffstat (limited to 'README.org')
-rw-r--r--README.org7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.org b/README.org
index c9245d7..2cbc066 100644
--- a/README.org
+++ b/README.org
@@ -359,6 +359,13 @@ PRs, issues, feature requests, and general feedback are very welcome!
3. Run the tests and ensure that your code doesn't break any of them.
4. Create a pull request referencing the issue created in step 1.
+*** coding style
+
+- This library uses an unconvential double dash (=--=) between file namespaces and function names, which contradicts normal Elisp style. This needs to be respected until the whole library is changed.
+- Use =aggressive-indent-mode= or similar to keep your code indented.
+- Single spaces end sentences in docstrings.
+- There's no need for a blank line after the first docstring line (one is added automatically when documentation is displayed).
+
** Supporting mastodon.el
If you'd like to support continued development of =mastodon.el=, I accept