[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."))
- [elpa] externals/url-scgi 103dd508e1 03/48: url-scgi.el: Support Emacs 24, (continued)
- [elpa] externals/url-scgi 103dd508e1 03/48: url-scgi.el: Support Emacs 24, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 62a6cf9305 07/48: Update documentation and add new doc/ directory, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 248962b6d6 08/48: url-scgi: Fix scgi socket on absolute path, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 8f5564a783 10/48: url-scgi: untabify, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 60154c472f 01/48: Add COPYING file containing the GPLv3., ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 3686dad2bd 04/48: Cleanups in url-scgi.el, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi f868b8be51 05/48: Support using xmlrpc over a file bound socket, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 1f76fba6a2 06/48: Use lexical binding, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi efd8de5ec8 09/48: url-scgi: fix compile time warning, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 44ee68353b 12/48: url-scgi: Add first unit tests, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 37f3ce8fa6 22/48: Fix some comments and docstrings,
ELPA Syncer <=
- [elpa] externals/url-scgi 66a7d265ff 13/48: Fix the workaround for bug in xml-rpc.el, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi a5fa019e7f 21/48: url-scgi: Fix cl-check-type bug on Emacs 26.1, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 2b22e6ffa9 11/48: url-scgi: Fix naming to not clutter namespace, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi a6ceb9f71d 14/48: Silence byte compiler warnings, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi e9e8323d86 15/48: Use new 'cl-lib rather than old 'cl, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 0d031d258f 18/48: Bump copyright year to 2017, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi dae60fe387 20/48: url-scgi: fix local socket on Emacs 25, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi e8eeb679c6 27/48: Update copyright year, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi 9c9170a7c3 33/48: Re-indent, ELPA Syncer, 2022/10/28
- [elpa] externals/url-scgi c5a548ac36 30/48: Fix quoting of characters, ELPA Syncer, 2022/10/28