aboutsummaryrefslogtreecommitdiff
path: root/sx-request.el
diff options
context:
space:
mode:
authorSean Allred <code@seanallred.com>2014-11-18 23:15:55 -0500
committerSean Allred <code@seanallred.com>2014-11-18 23:15:55 -0500
commit23d25719deb31694f12750a638872a175aae0419 (patch)
tree81bb729b4c5bda6392edba2b741b6d677132a7f9 /sx-request.el
parent11b698a4c750c379a8c0d4d843744913e931d3fe (diff)
Documentation -- part three
Source code is documented to the best of my knowledge and understanding.
Diffstat (limited to 'sx-request.el')
-rw-r--r--sx-request.el4
1 files changed, 3 insertions, 1 deletions
diff --git a/sx-request.el b/sx-request.el
index 0434a7b..b3668fe 100644
--- a/sx-request.el
+++ b/sx-request.el
@@ -171,7 +171,9 @@ contains a 'vector'. See `sx-request--build-keyword-arguments'."
(concat base "?" args))))
(defun sx-request--build-keyword-arguments (alist &optional kv-value-sep)
- "Build a \"key=value&key=value&...\"-style string with the elements
+ "Format ALIST as a key-value joined with KV-VALUE-SEP.
+
+Build a \"key=value&key=value&...\"-style string with the elements
of ALIST. If any value in the alist is `nil', that pair will not
be included in the return. If you wish to pass a notion of
false, use the symbol `false'. Each element is processed with