aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Allred <code@seanallred.com>2014-10-31 00:03:48 -0400
committerSean Allred <code@seanallred.com>2014-10-31 00:03:48 -0400
commitc41fcf7834b5bd766991e55d3e7b72571d17eca3 (patch)
tree575db3ecbe87d8f44930380e44564c5117b19338
parent4954a18753bc7a9a30097bfc2cb36aca495935a1 (diff)
Simplify explanation of arguments structure
The consing that was happening actually formed a much easier-to-understand list of lists.
-rw-r--r--stack-core.el21
1 files changed, 14 insertions, 7 deletions
diff --git a/stack-core.el b/stack-core.el
index 3dd1fb5..a915352 100644
--- a/stack-core.el
+++ b/stack-core.el
@@ -52,13 +52,20 @@
"The base URL to make requests from.")
(defcustom stack-core-default-keyword-arguments-alist
- '(("filters/create" . nil)
- (t . ((site . emacs))))
- "An alist of keywords to use as the default for a given method.
-This collection is in itself an alist; the key is the method and
-the value is an alist of the default arguments for this method.
-The value for `t' is the default-default... a super-default, if
-you will.
+ '(("filters/create")
+ ("sites")
+ (t (site . emacs)))
+ "Keywords to use as the default for a given method.
+
+The first element of each list is the method call the keywords
+apply to. The remaining cons cells (and they must be conses) are
+the values for each keyword.
+
+For each list, if no keywords are provided, the method's
+arguments are forced to the default as determined by the API.
+
+For each cons cell, if the cdr is `nil', then the keyword will be
+forced to the default as determined by the API.
See `stack-core-get-default-keyword-arguments' and
`stack-core-build-keyword-arguments'.