branch: externals/ellama
commit 314b4755d121fd6874fb0d9226fc3c709bcbb351
Author: Sergey Kostyaev <[email protected]>
Commit: Sergey Kostyaev <[email protected]>
docs: generalize docstring verb-form rule
---
AGENTS.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/AGENTS.md b/AGENTS.md
index 1d1b1b3828..647bb3160d 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -17,6 +17,8 @@
- **Docstrings**: Oneāline summary, then optional details; keep under 80 chars
per line. Do not add empty lines. If there are multiple sentences on one
line,
sentences should be separated by two spaces.
+ Use base verb form in function docstrings (no `-s`), e.g. `contain` not
+ `contains`, `return` not `returns`.
- **Comments**: Prefix with `;;` for buffer comments; avoid inline `#` clutter.
## Operation Guidelines