branch: elpa/aidermacs
commit 13b5a58b30e45c26a0678a43f55a221df56aad08
Author: Martin Šošić <[email protected]>
Commit: Matthew Zeng <[email protected]>
Fix the part about the "AI" comments in the README.md
Tiny fix, but I was just going through the Aider docs and found this to be
out of sync with them, so I updated it accordingly! Coming from Haskell,
knowing that there is support for `--` also is nice :).
---
README.md | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/README.md b/README.md
index a088d2c1e1..db130e71d6 100644
--- a/README.md
+++ b/README.md
@@ -374,13 +374,11 @@ Enable watching for AI coding instructions in your
repository files with `aiderm
When enabled, Aidermacs will will watch all files in your repo and look for
any AI coding instructions you add using your favorite IDE or text editor.
-Specifically, aider looks for one-liner comments (`# ...` or `// ...`) that
either start or end with `AI`, `AI!` or `AI?` like these:
+Specifically, aider looks for one-liner comments (`# ...`, `// ...` or `--
...`, regardless of the comment style that language supports) that either start
or end with `AI`, `AI!` or `AI?` like these:
```
# Make a snake game. AI!
# What is the purpose of this method AI?
-Or in // comment languages…
-
// Write a protein folding prediction engine. AI!
```
Aidermacs will take note of all the comments that start or end with `AI`.
Comments that include `AI!` with an exclamation point or `AI?` with a question
mark are special. They trigger aider to take action to collect all the AI
comments and use them as your instructions.
