diff options
| author | marty hiatt <martianhiatus [a t] riseup [d o t] net> | 2023-01-13 12:17:59 +0100 |
|---|---|---|
| committer | marty hiatt <martianhiatus [a t] riseup [d o t] net> | 2023-01-13 12:17:59 +0100 |
| commit | 061771766f1f9f10d1f33b4120eda4814256c664 (patch) | |
| tree | e6a260c8449d72f5b69ed417d50846738d5ab935 /README.org | |
| parent | df46317f64d943ce8d4c786c970100b6a94f3515 (diff) | |
readme: coding style pointers
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -367,6 +367,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 |