branch: externals/ellama
commit 9d15b5439644d088cdbccc4b737420fd2d3e18b0
Author: Sergey Kostyaev <[email protected]>
Commit: Sergey Kostyaev <[email protected]>
Refine style guidelines and remove old instructions
Updated docstring formatting rules in AGENTS.md. Removed legacy
instructions.org
file.
---
AGENTS.md | 3 ++-
docs/instructions.org | 12 ------------
2 files changed, 2 insertions(+), 13 deletions(-)
diff --git a/AGENTS.md b/AGENTS.md
index 885178adb9..1d1b1b3828 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -15,7 +15,8 @@
- In `ellama-tools.el` in tool spec use `snake_case`.
- **Error handling**: Wrap risky calls in `(condition-case err ...)` and
signal with `(error "msg")` when appropriate.
- **Docstrings**: One‑line summary, then optional details; keep under 80 chars
- per line. Do not add empty lines.
+ per line. Do not add empty lines. If there are multiple sentences on one
line,
+ sentences should be separated by two spaces.
- **Comments**: Prefix with `;;` for buffer comments; avoid inline `#` clutter.
## Operation Guidelines
diff --git a/docs/instructions.org b/docs/instructions.org
deleted file mode 100644
index 21b393f887..0000000000
--- a/docs/instructions.org
+++ /dev/null
@@ -1,12 +0,0 @@
-* About this project
-
-This project is written in emacs lisp.
-
-* Rules
-
-- 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.
