diff options
author | Sean Allred <code@seanallred.com> | 2014-11-18 21:53:44 -0500 |
---|---|---|
committer | Sean Allred <code@seanallred.com> | 2014-11-18 21:53:44 -0500 |
commit | 2d44aaa67c3d462debd35ce7b814f4d78e08fe29 (patch) | |
tree | 81618f3bd6b9d949c9b95a5952492171228d1af5 /sx-method.el | |
parent | 9df98091a366a3b1585ba52a21b0261b314ea8bd (diff) |
Documentation -- part two
Pushing this change to continue work elsewhere.
Diffstat (limited to 'sx-method.el')
-rw-r--r-- | sx-method.el | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/sx-method.el b/sx-method.el index 8838134..bd91e38 100644 --- a/sx-method.el +++ b/sx-method.el @@ -19,6 +19,11 @@ ;;; Commentary: +;;; This file is effectively a common-use wrapper for +;;; `sx-request-make'. It provides higher-level handling such as +;;; (authentication, filters, ...) that `sx-request-make' doesn't need +;;; to handle. + ;;; Code: (require 'json) (require 'url) @@ -30,7 +35,7 @@ (method &optional keyword-arguments filter) "Call METHOD with KEYWORD-ARGUMENTS using FILTER. -Return the entire response as a complex alist. +Return the response content as a complex alist. See `sx-request-make' and `sx-filter-get-var'." (sx-request-make |