branch: externals/repology
commit 0bf6f8071bc10df2cb6aabee08811ab0696f9345
Author: Nicolas Goaziou <m...@nicolasgoaziou.fr>
Commit: Nicolas Goaziou <m...@nicolasgoaziou.fr>
repology: Pacify checkdoc.
* repology.el (repology--parse-json):
(repology--build-url):
(repology--get): Fix docstring in order to pacify checkdoc.
---
repology.el | 13 ++++++-------
1 file changed, 6 insertions(+), 7 deletions(-)
diff --git a/repology.el b/repology.el
index 9bc6016..73a8eac 100644
--- a/repology.el
+++ b/repology.el
@@ -363,7 +363,7 @@ reset the cache and return nil."
(puthash key (cons (current-time) value) repology--cache))
(defun repology--parse-json (json-string)
- "Parse a JSON string and returns an object.
+ "Parse JSON-STRING and return an object.
JSON objects become alists and JSON arrays become lists."
(if (null json-string)
nil
@@ -392,7 +392,9 @@ JSON objects become alists and JSON arrays become lists."
(defun repology--build-url (action value start)
"Build a URL from an ACTION symbol.
-Value is a plist if ACTION is `projects', or a string otherwise."
+VALUE is a plist if ACTION is `projects', or a string otherwise.
+START is a string or nil. When it is a string and ACTION is `projects',
+ask Repology to only return projects alphabetically after it."
(concat repology-base-url
(symbol-name action)
"/"
@@ -406,11 +408,8 @@ Value is a plist if ACTION is `projects', or a string
otherwise."
(defun repology--get (action value start)
"Perform an HTTP GET request to Repology API.
-
-ACTION is a symbol. If it is `projects', VALUE is a plist and START a string.
-Otherwise, VALUE is a string, and START is nil.
-
-Information is returned as parsed JSON."
+ACTION, VALUE, and START are arguments passed to `repology--build-url',
+which see. Information is returned as parsed JSON."
(let ((key (repology--cache-key action value start)))
(or (repology--cache-get key)
(let ((request
