branch: elpa/aidermacs
commit c9d387c99062eef63aa7d0a11e2958dbb3978991
Author: Mingde (Matthew) Zeng <matthew...@posteo.net>
Commit: Mingde (Matthew) Zeng <matthew...@posteo.net>
Update Commentary throughout code
Addresses melpa/melpa#9373
---
aidermacs-backend-comint.el | 10 +++++++++-
aidermacs-backend-vterm.el | 11 ++++++++++-
aidermacs-backends.el | 10 +++++++++-
aidermacs-doom.el | 10 +++++++++-
aidermacs-models.el | 11 ++++++++++-
aidermacs.el | 14 ++++++++++++--
6 files changed, 59 insertions(+), 7 deletions(-)
diff --git a/aidermacs-backend-comint.el b/aidermacs-backend-comint.el
index 21799a187f..feb9f74536 100644
--- a/aidermacs-backend-comint.el
+++ b/aidermacs-backend-comint.el
@@ -10,7 +10,15 @@
;;
;;; Commentary:
;;
-;; Comint backend implementation for aidermacs.el
+;; This file implements the Comint backend for Aidermacs, providing
+;; an interface for interacting with the Aider process within an
+;; Emacs buffer. It handles sending commands to Aider, displaying
+;; output, and managing the interaction flow.
+;;
+;; Key features include:
+;; - Syntax highlighting for Aider's output, including search/replace blocks
and code fences.
+;; - Custom keybindings for multi-line input.
+;; - Management of the Aider process within a Comint buffer.
;;
;;; Code:
diff --git a/aidermacs-backend-vterm.el b/aidermacs-backend-vterm.el
index 71bdaa13e0..993b63ec7b 100644
--- a/aidermacs-backend-vterm.el
+++ b/aidermacs-backend-vterm.el
@@ -10,7 +10,16 @@
;;
;;; Commentary:
;;
-;; VTerm backend implementation for aidermacs.el
+;; This file implements the VTerm backend for Aidermacs, providing
+;; an interface for interacting with the Aider process within a
+;; VTerm buffer. It leverages the VTerm package for a more
+;; feature-rich terminal experience.
+;;
+;; Key features include:
+;; - Integration with the VTerm package for terminal emulation.
+;; - Asynchronous output processing using timers and advices.
+;; - Custom keybindings for multi-line input.
+;; - Management of the Aider process within a VTerm buffer.
;;
;;; Code:
diff --git a/aidermacs-backends.el b/aidermacs-backends.el
index dacd39d71e..21eca0a64c 100644
--- a/aidermacs-backends.el
+++ b/aidermacs-backends.el
@@ -10,7 +10,15 @@
;;
;;; Commentary:
;;
-;; Backend dispatcher for aidermacs.el
+;; This file serves as the backend dispatcher for Aidermacs,
+;; allowing users to choose between different backend implementations
+;; for interacting with the Aider process. Currently, it supports
+;; Comint and VTerm backends.
+;;
+;; Key features include:
+;; - Selection of the backend via the `aidermacs-backend` custom variable.
+;; - Abstraction of backend-specific functions for running Aider and sending
commands.
+;; - Management of output history and callbacks.
;;
;;; Code:
diff --git a/aidermacs-doom.el b/aidermacs-doom.el
index f62ba3a11f..7cec9d6f7d 100644
--- a/aidermacs-doom.el
+++ b/aidermacs-doom.el
@@ -10,7 +10,15 @@
;;
;;; Commentary:
;;
-;; Doom integration for aidermacs
+;; This file provides Doom Emacs integration for Aidermacs, offering
+;; convenient keybindings and commands for interacting with Aider
+;; within the Doom Emacs environment.
+;;
+;; Key features include:
+;; - Keybindings for common Aidermacs actions, such as running Aider,
+;; adding files, and asking questions.
+;; - Integration with Doom Emacs' keybinding system.
+;; - Automatic setup of keybindings in Git repositories.
;;
;;; Code:
diff --git a/aidermacs-models.el b/aidermacs-models.el
index 0ff48146ea..38132b669b 100644
--- a/aidermacs-models.el
+++ b/aidermacs-models.el
@@ -10,7 +10,16 @@
;;
;;; Commentary:
;;
-;; Model selection functionality for aidermacs.el
+;; This file provides model selection functionality for Aidermacs,
+;; allowing users to choose between different AI models for their
+;; Aider sessions. It supports fetching models from various API
+;; providers and caching them for faster access.
+;;
+;; Key features include:
+;; - Selection of AI models via a completing-read interface.
+;; - Fetching of available models from OpenAI-compatible API endpoints.
+;; - Caching of models for faster access.
+;; - Customization of default models for different tasks.
;;
;;; Code:
diff --git a/aidermacs.el b/aidermacs.el
index 311b3b3254..01b74cc38d 100644
--- a/aidermacs.el
+++ b/aidermacs.el
@@ -11,8 +11,18 @@
;;
;;; Commentary:
;;
-;; This package provides an interactive interface to communicate
-;; with https://github.com/paul-gauthier/aidermacs.
+;; Aidermacs is an Emacs package that integrates with Aider, an AI
+;; pair programming tool, to bring AI-powered code modification and
+;; assistance to your Emacs workflow. It allows you to interact with
+;; Aider through an Emacs buffer, providing commands for adding and
+;; dropping files, asking questions, generating code, and more.
+;;
+;; Key features include:
+;; - Integration with Aider for AI-assisted code modification.
+;; - Support for multiple backends, including Comint and VTerm.
+;; - Commands for managing files, asking questions, and generating code.
+;; - Transient menus for easy access to commands.
+;; - Minor mode for convenient keybindings in prompt files.
;;
;;; Code:
