From 222987f9c59d8655afd63d0d5106cacecb816bcc Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Fri, 23 Feb 2024 08:44:55 -0800 Subject: [PATCH] INSTRUCTIONS.md -> CONVENTIONS.md --- docs/faq.md | 4 ++-- docs/instructions.md | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 99f3b7ebd..634479a7d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -364,7 +364,7 @@ like whether to provide type hints, which libraries or packages to prefer, etc. 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 -[using an instructions file with aider](/docs/instructions.md). +[using a conventions file with aider](/docs/instructions.md). diff --git a/docs/instructions.md b/docs/instructions.md index e19b34540..2bef2da03 100644 --- a/docs/instructions.md +++ b/docs/instructions.md @@ -14,15 +14,15 @@ For example, say we want our python code to: - 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) that we want to edit:
-> $ aider INSTRUCTIONS.md useragent.py +> $ aider CONVENTIONS.md useragent.py > > Aider v0.24.2-dev -> Added INSTRUCTIONS.md to the chat. +> Added CONVENTIONS.md 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. @@ -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. See below for the transcript of this same coding task conducted *without* -using `INSTRUCTIONS.md`. +using `CONVENTIONS.md`. In this case, GPT used `requests` and skipped types, which is perhaps more typical in small python scripts.