branch: elpa/aidermacs
commit 5ff962cdf2d57c5abb1cb8de056965a26c59c60c
Author: Mingde (Matthew) Zeng <matthew...@posteo.net>
Commit: Mingde (Matthew) Zeng <matthew...@posteo.net>
Improve Commentary
---
aidermacs-backend-comint.el | 19 +++++++++----------
aidermacs-backend-vterm.el | 21 ++++++++++-----------
aidermacs-backends.el | 19 +++++++++----------
aidermacs-models.el | 21 ++++++++++-----------
aidermacs.el | 25 ++++++++++++-------------
5 files changed, 50 insertions(+), 55 deletions(-)
diff --git a/aidermacs-backend-comint.el b/aidermacs-backend-comint.el
index 0b2a87e965..22609d2597 100644
--- a/aidermacs-backend-comint.el
+++ b/aidermacs-backend-comint.el
@@ -1,7 +1,7 @@
-;;; aidermacs-backend-comint.el --- Comint backend for aidermacs.el -*-
lexical-binding: t; -*-
+;;; aidermacs-backend-comint.el --- Comint backend for aidermacs -*-
lexical-binding: t; -*-
;; Author: Mingde (Matthew) Zeng <matthew...@posteo.net>
;; Version: 1.0.0
-;; Keywords: ai emacs agents llm aider ai-pair-programming, convenience, tools
+;; Keywords: ai emacs llm aider ai-pair-programming tools
;; URL: https://github.com/MatthewZMD/aidermacs
;; Originally forked from: Kang Tu <tni...@gmail.com> Aider.el
;; SPDX-License-Identifier: Apache-2.0
@@ -10,15 +10,14 @@
;;
;;; Commentary:
;;
-;; 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.
+;; Implements Comint backend for Aidermacs, providing interface to
+;; interact with Aider process in Emacs buffer. Handles command
+;; sending, output display, and interaction flow.
;;
-;; Key features include:
-;; - Syntax highlighting for Aider's output.
-;; - Custom keybindings for multi-line input.
-;; - Management of the Aider process within a Comint buffer.
+;; Features:
+;; - Syntax highlighting for Aider output
+;; - Custom keybindings for multi-line input
+;; - Process management in Comint buffer
;;
;;; Code:
diff --git a/aidermacs-backend-vterm.el b/aidermacs-backend-vterm.el
index 6cfcf33788..79ca291a7e 100644
--- a/aidermacs-backend-vterm.el
+++ b/aidermacs-backend-vterm.el
@@ -1,7 +1,7 @@
-;;; aidermacs-backend-vterm.el --- VTerm backend for aidermacs.el -*-
lexical-binding: t; -*-
+;;; aidermacs-backend-vterm.el --- VTerm backend for aidermacs -*-
lexical-binding: t; -*-
;; Author: Mingde (Matthew) Zeng <matthew...@posteo.net>
;; Version: 1.0.0
-;; Keywords: ai emacs agents llm aider ai-pair-programming, convenience, tools
+;; Keywords: ai emacs llm aider ai-pair-programming tools
;; URL: https://github.com/MatthewZMD/aidermacs
;; Originally forked from: Kang Tu <tni...@gmail.com> Aider.el
;; SPDX-License-Identifier: Apache-2.0
@@ -10,16 +10,15 @@
;;
;;; Commentary:
;;
-;; 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.
+;; Implements VTerm backend for Aidermacs, providing interface to
+;; interact with Aider process in VTerm buffer. Uses VTerm package
+;; for 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.
+;; Features:
+;; - VTerm integration for terminal emulation
+;; - Async output processing with timers
+;; - Custom multi-line input keybindings
+;; - Aider process management in VTerm
;;
;;; Code:
diff --git a/aidermacs-backends.el b/aidermacs-backends.el
index d401343172..9d5563e9d5 100644
--- a/aidermacs-backends.el
+++ b/aidermacs-backends.el
@@ -1,7 +1,7 @@
-;;; aidermacs-backends.el --- Backend implementations for aidermacs.el -*-
lexical-binding: t; -*-
+;;; aidermacs-backends.el --- Backend dispatcher for aidermacs -*-
lexical-binding: t; -*-
;; Author: Mingde (Matthew) Zeng <matthew...@posteo.net>
;; Version: 1.0.0
-;; Keywords: ai emacs agents llm aider ai-pair-programming, convenience, tools
+;; Keywords: ai emacs llm aider ai-pair-programming tools
;; URL: https://github.com/MatthewZMD/aidermacs
;; Originally forked from: Kang Tu <tni...@gmail.com> Aider.el
;; SPDX-License-Identifier: Apache-2.0
@@ -10,15 +10,14 @@
;;
;;; Commentary:
;;
-;; 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.
+;; Backend dispatcher for Aidermacs, allowing choice between
+;; different backend implementations for Aider process.
+;; 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.
-;; - Management of output history and callbacks.
+;; Features:
+;; - Backend selection via `aidermacs-backend` variable
+;; - Abstracts backend-specific Aider functions
+;; - Manages output history and callbacks
;;
;;; Code:
diff --git a/aidermacs-models.el b/aidermacs-models.el
index 932598bacc..6ded9bfe0f 100644
--- a/aidermacs-models.el
+++ b/aidermacs-models.el
@@ -1,7 +1,7 @@
-;;; aidermacs-models.el --- Model selection for aidermacs.el -*-
lexical-binding: t; -*-
+;;; aidermacs-models.el --- Model selection for aidermacs -*- lexical-binding:
t; -*-
;; Author: Mingde (Matthew) Zeng <matthew...@posteo.net>
;; Version: 1.0.0
-;; Keywords: ai emacs agents llm aider ai-pair-programming, convenience, tools
+;; Keywords: ai emacs llm aider ai-pair-programming tools
;; URL: https://github.com/MatthewZMD/aidermacs
;; Originally forked from: Kang Tu <tni...@gmail.com> Aider.el
;; SPDX-License-Identifier: Apache-2.0
@@ -10,16 +10,15 @@
;;
;;; Commentary:
;;
-;; 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.
+;; Provides model selection for Aidermacs, allowing choice between
+;; different AI models for Aider sessions. Supports fetching models
+;; from various API providers and caching 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.
+;; Features:
+;; - Model selection via completing-read interface
+;; - Fetch models from OpenAI-compatible APIs
+;; - Model caching for faster access
+;; - Custom default models for different tasks
;;
;;; Code:
diff --git a/aidermacs.el b/aidermacs.el
index 5b292468ad..a60867742e 100644
--- a/aidermacs.el
+++ b/aidermacs.el
@@ -1,8 +1,8 @@
-;;; aidermacs.el --- Aidermacs package for interactive conversation with aider
-*- lexical-binding: t; -*-
+;;; aidermacs.el --- AI pair programming with Aider in Emacs -*-
lexical-binding: t; -*-
;; Author: Mingde (Matthew) Zeng <matthew...@posteo.net>
;; Version: 1.0.0
;; Package-Requires: ((emacs "28.1"))
-;; Keywords: ai emacs agents llm aider ai-pair-programming, convenience, tools
+;; Keywords: ai emacs llm aider ai-pair-programming tools
;; URL: https://github.com/MatthewZMD/aidermacs
;; Originally forked from: Kang Tu <tni...@gmail.com> Aider.el
;; SPDX-License-Identifier: Apache-2.0
@@ -11,18 +11,17 @@
;;
;;; Commentary:
;;
-;; 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.
+;; Aidermacs integrates with Aider for AI-assisted code modification
+;; in Emacs. Provides interface to interact with Aider through Emacs
+;; buffer with commands for file management, code generation, and
+;; question answering.
;;
-;; 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.
+;; Features:
+;; - AI-assisted code modification
+;; - Multiple backends (Comint and VTerm)
+;; - File management commands
+;; - Transient menus for quick access
+;; - Minor mode for prompt files
;;
;;; Code:
