From 2d44aaa67c3d462debd35ce7b814f4d78e08fe29 Mon Sep 17 00:00:00 2001 From: Sean Allred Date: Tue, 18 Nov 2014 21:53:44 -0500 Subject: Documentation -- part two Pushing this change to continue work elsewhere. --- sx-method.el | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'sx-method.el') 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 -- cgit v1.2.3