get ready for packagingv1.0

1 files changed, 36 insertions, 5 deletions

diff --git a/llm-tools-hl.el b/llm-tools-hl.el
index b095a6e..daf9edd 100644
--- a/llm-tools-hl.el
+++ b/llm-tools-hl.el
@@ -1,4 +1,35 @@
-;; -*- lexical-binding: t; -*-
+;; llm-tools-hl.el --- Hashline file operations for llm-tools  -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2026 Vineet K
+
+;; Author: Vineet K <git@vineetk.net>
+;; Version: 1.0
+;; Keywords: llm, gptel
+;; Package-Requires: ((emacs "28.1"))
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; Hashline-based file operations for the llm-tools package.
+;; Provides functions for reading, editing, and verifying files using
+;; a content-addressed line format.
+
+;;; Code:
+
+(require 'cl-lib)
+
 (defvar llm-tools--hl-bigrams
   (list "aa" "ab" "ac" "ad" "ae" "af" "ag" "ah" "ai" "aj" "ak" "al" "am" "an"
         "ao" "ap" "aq" "ar" "as" "at" "au" "av" "aw" "ax" "ay" "az" "ba" "bb"
@@ -119,7 +150,7 @@ single string."
          (not (string-prefix-p "#" trimmed)))))
 
 (defun llm-tools--hl-parse-op-line-for-verify (line)
-  "Parse a single operation LINE (e.g. \"+ 4ei\") into a `hl-verify-op`."
+  "Parse a single operation LINE (e.g. \"+ 4ei\") into a `hl-verify-op'."
   (let* ((trimmed (string-trim line))
          (ch (substring trimmed 0 1)))
     (make-hl-verify-op
@@ -334,7 +365,7 @@ line in the on-disk file."
   (string-to-number (substring anchor 0 (- (length anchor) 2))))
 
 (defun llm-tools--hl-parse-op-line (line)
-  "Parse a single operation LINE into an `hl-op` struct.
+  "Parse a single operation LINE into an `hl-op' struct.
 LINE must start with `+`, `<`, `-`, or `=`, followed by a space,
 followed by an anchor (or range)."
   (string-match "^[+<=-] \\(.*\\)" line)  ; returns index or nil
@@ -349,7 +380,7 @@ followed by an anchor (or range)."
       ("=" (make-hl-op :type 'replace :range (split-string anchor "\\.\\."))))))
 
 (defun llm-tools--hl-parse-section (section)
-  "Parse SECTION (body after `@@ PATH`) into a list of `hl-op` structs.
+  "Parse SECTION (body after `@@ PATH`) into a list of `hl-op' structs.
 Skips comment lines (starting with `#`) and blank lines."
   (let (ops op)
     (dolist (line (string-lines section))
@@ -414,7 +445,7 @@ FILENAME."
           (- offset (- b a 1)))))
 
 (defun llm-tools--hl-apply-replace (range payload content offset)
-  "Replace lines from (car RANGE) to (cadr RANGE) with PAYLOAD (nil → '(\"\"))"
+  "Replace lines from (car RANGE) to (cadr RANGE) with PAYLOAD (nil to '(\"\"))"
   (let ((a (+ (llm-tools--hl-anchor-to-line-num (car range)) offset))
         (b (+ (llm-tools--hl-anchor-to-line-num (cadr range)) offset))
         (payload (or payload '(""))))