dearwolf/aider
1
0
Fork 0
mirror of https://github.com/Aider-AI/aider.git synced 2025-05-28 16:25:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

INSTRUCTIONS.md -> CONVENTIONS.md

Browse source
This commit is contained in:
Paul Gauthier 2024-02-23 08:44:55 -08:00
parent 644077bdcb
commit 222987f9c5
2 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/faq.md
View file

@ -364,7 +364,7 @@ like whether to provide type hints, which libraries or packages
to prefer, etc. to prefer, etc.
Just put any extra instructions in a file Just put any extra instructions in a file
like `INSTRUCTIONS.md` and then add it to the chat. like `CONVENTIONS.md` and then add it to the chat.
For more details, see this documentation on For more details, see this documentation on
[using an instructions file with aider](/docs/instructions.md). [using a conventions file with aider](/docs/instructions.md).

8
docs/instructions.md
View file

@ -14,15 +14,15 @@ For example, say we want our python code to:
- Use types everywhere possible. - Use types everywhere possible.
``` ```
We would simply create a file like `INSTRUCTIONS.md` with those lines We would simply create a file like `CONVENTIONS.md` with those lines
and then we can add it to the aider chat, along with the file(s) and then we can add it to the aider chat, along with the file(s)
that we want to edit: that we want to edit:
<div class="chat-transcript" markdown="1"> <div class="chat-transcript" markdown="1">
> $ aider INSTRUCTIONS.md useragent.py > $ aider CONVENTIONS.md useragent.py
> >
> Aider v0.24.2-dev > Aider v0.24.2-dev
> Added INSTRUCTIONS.md to the chat. > Added CONVENTIONS.md to the chat.
> Added useragent.py to the chat. > Added useragent.py to the chat.
#### write a function that uses httpbin to check the user agent on the request. return the ua. #### write a function that uses httpbin to check the user agent on the request. return the ua.
@ -53,7 +53,7 @@ This function uses `httpx` to make a GET request to `httpbin.org/user-agent`, wh
GPT correctly used `httpx` and provided type hints. GPT correctly used `httpx` and provided type hints.
See below for the transcript of this same See below for the transcript of this same
coding task conducted *without* coding task conducted *without*
using `INSTRUCTIONS.md`. using `CONVENTIONS.md`.
In this case, GPT used `requests` and skipped types, In this case, GPT used `requests` and skipped types,
which is perhaps more typical in small python scripts. which is perhaps more typical in small python scripts.