aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArtur Malabarba <bruce.connor.am@gmail.com>2015-04-18 08:42:57 +0100
committerArtur Malabarba <bruce.connor.am@gmail.com>2015-04-18 08:42:57 +0100
commit717d22d6709b9df12d6bfd38bc4b0475e34d50f1 (patch)
tree180f8dd2262b354b114f3dfd99fd635b9001b5d2
parente453cf88c4f721686f54ebd257eaffa2179653b0 (diff)
Improve sx-method-call documentation.
-rw-r--r--sx-method.el28
1 files changed, 14 insertions, 14 deletions
diff --git a/sx-method.el b/sx-method.el
index f2e68b3..e458213 100644
--- a/sx-method.el
+++ b/sx-method.el
@@ -46,22 +46,22 @@
site)
"Call METHOD with additional keys.
-:ID is the id associated with a question, answer, comment, post or
+ID is the id associated with a question, answer, comment, post or
user.
-:SUBMETHOD is the additional segments of the method.
-:KEYWORDS are the api parameters.
-:FILTER is the set of filters to control the returned information
-:AUTH defines how to act if the method or filters require
+SUBMETHOD is the additional segments of the method.
+KEYWORDS are the api parameters. Some parameters have their own
+keywords too, for convenience. The KEYWORDS argument overrides
+parameter specific keywords.
+FILTER is the set of filters to control the returned information
+AUTH defines how to act if the method or filters require
authentication.
-:URL-METHOD is either `post' or `get'
-:SITE is the api parameter specifying the site.
-:GET-ALL is nil or non-nil
-:PROCESS-FUNCTION is a response-processing function
-:PAGE is the page number which will be requested
-:PAGESIZE is the number of items to retrieve per request, default 100
-
-Any conflicting information in :KEYWORDS overrides the :PAGE
-and :PAGESIZE settings.
+URL-METHOD is either `post' or `get'
+SITE is the api parameter specifying the site.
+GET-ALL is nil or non-nil
+PROCESS-FUNCTION is a response-processing function
+PAGE is the page number which will be requested
+PAGESIZE is the number of items to retrieve per request, default
+100
When AUTH is nil, it is assumed that no auth-requiring filters or
methods will be used. If they are an error will be signaled. This is