branch: externals/ellama
commit 1dc50acd2fe90facee68f833165b1625e9db3749
Author: Sergey Kostyaev <sskosty...@gmail.com>
Commit: Sergey Kostyaev <sskosty...@gmail.com>
Update coding guidelines
Added new rules for function docstrings:
- Arguments in docstrings should be uppercased.
- Multiple sentences in a single line of
docstrings should be separated by double spaces.
---
docs/instructions.org | 3 +++
1 file changed, 3 insertions(+)
diff --git a/docs/instructions.org b/docs/instructions.org
index 0a123e3093..21b393f887 100644
--- a/docs/instructions.org
+++ b/docs/instructions.org
@@ -7,3 +7,6 @@ This project is written in emacs lisp.
- Write simple and readable code.
- Always use ~ert~ for tests.
- All function names and custom variable names should start with ~ellama-~.
+- Function docstrings should contain all arguments in uppercase, like SOME-ARG.
+- In docstrings, if there are multiple sentences on one line,
+ sentences should be separated by two spaces.
