emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/url-scgi 37f3ce8fa6 22/48: Fix some comments and docstr


From: ELPA Syncer
Subject: [elpa] externals/url-scgi 37f3ce8fa6 22/48: Fix some comments and docstrings
Date: Fri, 28 Oct 2022 22:58:30 -0400 (EDT)

branch: externals/url-scgi
commit 37f3ce8fa6ef34d76fa085473e4264201ba9b6b0
Author: Stefan Kangas <stefankangas@gmail.com>
Commit: Stefan Kangas <stefankangas@gmail.com>

    Fix some comments and docstrings
---
 url-scgi.el | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/url-scgi.el b/url-scgi.el
index 13af761e73..3034b10742 100644
--- a/url-scgi.el
+++ b/url-scgi.el
@@ -24,6 +24,8 @@
 
 ;;; Commentary:
 
+;; This is heavily based on the url-http.el library.
+;;
 ;; The SCGI specification document can be found at:
 ;;
 ;; http://python.ca/scgi/protocol.txt
@@ -60,7 +62,7 @@
 (defvar url-request-data)
 
 (defun url-scgi-string-to-netstring (str)
-  "Converts a string into a SCGI protocol netstring."
+  "Convert string STR into a SCGI protocol netstring."
   (format "%d:%s," (length str) str))
 
 (defun url-scgi-add-null-bytes (&rest args)
@@ -88,7 +90,12 @@
 
 ;;;###autoload
 (defun url-scgi (url callback cbargs)
-  "Handle SCGI URLs from internal Emacs functions."
+  "Handle SCGI URLs from internal Emacs functions.
+
+URL must be a parsed URL.  See `url-generic-parse-url' for details.
+
+When retrieval is completed, execute the function CALLBACK, passing it
+an updated value of CBARGS as arguments."
   (if (>= emacs-major-version 26)
       (cl-check-type url url "Need a pre-parsed URL.")
     (cl-check-type url vector "Need a pre-parsed URL."))



reply via email to

[Prev in Thread] Current Thread [Next in Thread]