From f237d0f21232664953d08b4e36138ba68c43a051 Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Mon, 16 Dec 2024 19:50:08 -0800 Subject: [PATCH] copy --- aider/website/docs/install.md | 7 +++++-- aider/website/docs/install/optional.md | 6 +++--- aider/website/docs/more/edit-formats.md | 20 +++++++++++++++----- 3 files changed, 23 insertions(+), 10 deletions(-) diff --git a/aider/website/docs/install.md b/aider/website/docs/install.md index a48e788c6..eb18470e6 100644 --- a/aider/website/docs/install.md +++ b/aider/website/docs/install.md @@ -13,10 +13,13 @@ description: How to install and get started pair programming with aider. {% include get-started.md %} +This will install aider in its own separate python environment. If needed, -aider-install will automatically install a separate version of python 3.12 to use with aider. +aider-install will also install a separate version of python 3.12 to use with aider. + +Once aider is installed, +there are also some [optional install steps](/docs/install/optional.html). -There are some [optional install steps](/docs/install/optional.html) you could consider. See the [usage instructions](https://aider.chat/docs/usage.html) to start coding with aider. ## One-liners diff --git a/aider/website/docs/install/optional.md b/aider/website/docs/install/optional.md index 901274d49..818f9f2c3 100644 --- a/aider/website/docs/install/optional.md +++ b/aider/website/docs/install/optional.md @@ -80,8 +80,8 @@ You can use [aider's `--watch-files` mode](https://aider.chat/docs/usage/watch.html) to integrate with any IDE or editor. -Other projects have made plugins for various IDE/editors. -It's not clear if they are tracking the latest +There are a number of 3rd party aider plugins for various IDE/editors. +It's not clear how well they are tracking the latest versions of aider, so it may be best to just run the latest aider in a terminal alongside your editor and use `--watch-files`. @@ -101,7 +101,7 @@ There are a number of 3rd party ### Other editors If you are interested in creating an aider plugin for your favorite editor, -please let me know by opening a +please let us know by opening a [GitHub issue](https://github.com/Aider-AI/aider/issues). diff --git a/aider/website/docs/more/edit-formats.md b/aider/website/docs/more/edit-formats.md index 870284cc4..cabf6cc94 100644 --- a/aider/website/docs/more/edit-formats.md +++ b/aider/website/docs/more/edit-formats.md @@ -20,7 +20,7 @@ copy of each source file that needs changes. While simple, it can be slow and costly because the LLM has to return the *entire file* even if just a few lines are edited. -The format expects the file path just before the fenced file content: +The whole format expects the file path just before the fenced file content: ```` show_greeting.py @@ -28,7 +28,7 @@ show_greeting.py import sys def greeting(name): - print(f"Hey {{name}}") + print("Hey", name) if __name__ == '__main__': greeting(sys.argv[1]) @@ -42,7 +42,7 @@ The "diff" edit format asks the LLM to specify file edits as a series of search/ This is an efficient format, because the model only needs to return parts of the file which have changes. -They are formatted using a syntax similar to the git merge conflict resolution markings, +Edits are formatted using a syntax similar to the git merge conflict resolution markings, with the file path right before a fenced block: ```` @@ -62,7 +62,7 @@ from flask import Flask The "diff-fenced" edit format is based on the diff format, but the file path is placed inside the fence. It is primarily used with the Gemini family of models, -which often fail to conform to fencing approach specified in the diff format. +which often fail to conform to the fencing approach specified in the diff format. ```` ``` @@ -84,7 +84,10 @@ This is an efficient format, because the model only needs to return parts of the which have changes. It was mainly used to the GPT-4 Turbo family of models, -to reduce their "lazy coding" tendencies with other edit formats. +because it reduced their "lazy coding" tendencies. +With other edit formats the GPT-4 Turbo models tended to elide +large sections of code and replace them with "# ... original code here ..." +style comments. ```` @@ -104,3 +107,10 @@ to reduce their "lazy coding" tendencies with other edit formats. These are streamlined versions of the diff and whole formats, intended to be used with `--editor-edit-format` when using [architect mode](/docs/usage/modes.html). +The actual edit format is the same, but aider uses a simpler prompt that +is more narrowly focused on just editing the file as opposed to +solving the coding task. +The architect model resolves the coding task and +provides plain text instructions about which file changes need to be made. +The editor interprets those instructions to produce the +syntactically correct diff or whole edits.