branch: elpa/gptel commit 913e9dba2a977647b1cc2cc8ec368ac896cc47c2 Author: Karthik Chikmagalur <karthikchikmaga...@gmail.com> Commit: Karthik Chikmagalur <karthikchikmaga...@gmail.com>
gptel: Update docstrings, GPTel to gptel * gptel.el (gptel-curl-file-size-threshold): Update spelling "GPTel" to "gptel". * gptel-transient.el: Ditto * gptel-curl.el (gptel-curl--stream-cleanup): Ditto * gptel-context.el: Ditto --- gptel-context.el | 4 ++-- gptel-curl.el | 6 +++--- gptel-transient.el | 2 +- gptel.el | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/gptel-context.el b/gptel-context.el index bae1748cfc..5b831cc485 100644 --- a/gptel-context.el +++ b/gptel-context.el @@ -1,4 +1,4 @@ -;;; gptel-context.el --- Context aggregator for GPTel -*- lexical-binding: t; -*- +;;; gptel-context.el --- Context aggregator for gptel -*- lexical-binding: t; -*- ;; Copyright (C) 2023 Karthik Chikmagalur @@ -23,7 +23,7 @@ ;;; Commentary: ;; The context allows you to conveniently create contexts which can be fed -;; to GPTel. +;; to gptel. ;;; Code: diff --git a/gptel-curl.el b/gptel-curl.el index cd914ab16a..f8cfd0f05f 100644 --- a/gptel-curl.el +++ b/gptel-curl.el @@ -1,4 +1,4 @@ -;;; gptel-curl.el --- Curl support for GPTel -*- lexical-binding: t; -*- +;;; gptel-curl.el --- Curl support for gptel -*- lexical-binding: t; -*- ;; Copyright (C) 2023 Karthik Chikmagalur @@ -22,7 +22,7 @@ ;;; Commentary: -;; Curl support for GPTel. Utility functions. +;; Curl support for gptel. Utility functions. ;;; Code: @@ -205,7 +205,7 @@ PROC-INFO is the plist containing process metadata." ;; TODO: Separate user-messaging from this function (defun gptel-curl--stream-cleanup (process _status) - "Process sentinel for GPTel curl requests. + "Process sentinel for gptel curl requests. PROCESS and _STATUS are process parameters." (let ((proc-buf (process-buffer process))) diff --git a/gptel-transient.el b/gptel-transient.el index 24dce163e7..9888768306 100644 --- a/gptel-transient.el +++ b/gptel-transient.el @@ -1,4 +1,4 @@ -;;; gptel-transient.el --- Transient menu for GPTel -*- lexical-binding: t; -*- +;;; gptel-transient.el --- Transient menu for gptel -*- lexical-binding: t; -*- ;; Copyright (C) 2023 Karthik Chikmagalur diff --git a/gptel.el b/gptel.el index 23e34cd6ae..fe46e7da9c 100644 --- a/gptel.el +++ b/gptel.el @@ -248,7 +248,7 @@ This only affects requests originating from Org mode buffers." "Size threshold for using file input with Curl. Specifies the size threshold for when to use a temporary file to pass data to -Curl in GPTel queries. If the size of the data to be sent exceeds this +Curl in gptel queries. If the size of the data to be sent exceeds this threshold, the data is written to a temporary file and passed to Curl using the `--data-binary' option with a file reference. Otherwise, the data is passed directly as a command-line argument. @@ -256,7 +256,7 @@ directly as a command-line argument. The value is an integer representing the number of bytes. Adjusting this value may be necessary depending on the environment -and the typical size of the data being sent in GPTel queries. +and the typical size of the data being sent in gptel queries. A larger value may improve performance by avoiding the overhead of creating temporary files for small data payloads, while a smaller value may be needed if the command-line argument size is limited by the operating system.