From 38a3b4309b38f93528c624aea388953db11c8fd0 Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Sat, 13 May 2023 10:26:29 -0700 Subject: [PATCH] Added update-docs example --- examples/update-docs.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 examples/update-docs.md diff --git a/examples/update-docs.md b/examples/update-docs.md new file mode 100644 index 000000000..2bb6f909f --- /dev/null +++ b/examples/update-docs.md @@ -0,0 +1,30 @@ +# Automatically update docs with aider and GPT-4 + +> The user asks aider to automatically update the Usage docs based on the latest version of the main() function in the code. + +#### > the cmd line args in main() have been updated. update the readme to accurately describe them. + +```markdown +README.md +<<<<<<< ORIGINAL +- `--history-file HISTORY_FILE`: Specify the chat input history file (default: .aider.history). Override the default with the environment variable `AIDER_HISTORY_FILE`. +- `--model MODEL`: Specify the model to use for the main chat (default: gpt-4). Override the default with the environment variable `AIDER_MODEL`. +- `-3`: Use gpt-3.5-turbo model for the main chat (basically won't work). No environment variable override. +- `--no-pretty`: Disable pretty, colorized output. Override the default with the environment variable `AIDER_PRETTY` (default: 1 for enabled, 0 for disabled). +- `--show-diffs`: Show diffs when committing changes (default: False). Override the default with the environment variable `AIDER_SHOW_DIFFS` (default: 0 for False, 1 for True). +- `--no-auto-commits`: Disable auto commit of changes. Override the default with the environment variable `AIDER_AUTO_COMMITS` (default: 1 for enabled, 0 for disabled). +======= +- `--input-history-file INPUT_HISTORY_FILE`: Specify the chat input history file (default: .aider.input.history). Override the default with the environment variable `AIDER_INPUT_HISTORY_FILE`. +- `--chat-history-file CHAT_HISTORY_FILE`: Specify the chat history file (default: .aider.chat.history.md). Override the default with the environment variable `AIDER_CHAT_HISTORY_FILE`. +- `--model MODEL`: Specify the model to use for the main chat (default: gpt-4). Override the default with the environment variable `AIDER_MODEL`. +- `-3`: Use gpt-3.5-turbo model for the main chat (basically won't work). No environment variable override. +- `--no-pretty`: Disable pretty, colorized output. Override the default with the environment variable `AIDER_PRETTY` (default: 1 for enabled, 0 for disabled). +- `--apply FILE`: Apply the changes from the given file instead of running the chat (debug). +- `--no-auto-commits`: Disable auto commit of changes. Override the default with the environment variable `AIDER_AUTO_COMMITS` (default: 1 for enabled, 0 for disabled). +- `--show-diffs`: Show diffs when committing changes (default: False). Override the default with the environment variable `AIDER_SHOW_DIFFS` (default: 0 for False, 1 for True). +- `--yes`: Always say yes to every confirmation (default: False). +>>>>>>> UPDATED +``` + +_Applied edit to README.md_ +_Commit 024f45e aider: Updated command line arguments in main() and updated README.md to accurately describe them._