diff options
| author | Sean Allred <code@seanallred.com> | 2014-11-02 11:51:39 -0500 |
|---|---|---|
| committer | Sean Allred <code@seanallred.com> | 2014-11-02 11:51:39 -0500 |
| commit | d2a8e8e9c146c0cce084f7b4e6371a882374435e (patch) | |
| tree | a3d8062d3e4e44ea25ba0b51e0f23caf1a57874b | |
| parent | a4adbdf59250807d5c1872df7f034029d6f44b08 (diff) | |
Checkdoc file
| -rw-r--r-- | stack-filter.el | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/stack-filter.el b/stack-filter.el index 75173a1..0229ad1 100644 --- a/stack-filter.el +++ b/stack-filter.el @@ -34,7 +34,8 @@ (defvar stack-filter 'default - "The current filter. To customize the filter for the next call + "The current filter. +To customize the filter for the next call to `stack-core-make-request', let-bind this variable to the output of a call to `stack-core-compile-filter'. Be careful! If you're going to be using this new filter a lot, create a variable @@ -42,11 +43,11 @@ for it. Creation requests count against `stack-core-remaining-api-requests'!") -;;; Filter compilation +;;; Compilation +;;; TODO allow BASE to be a precompiled filter name (defun stack-filter-compile (&optional include exclude base) - "Compile a StackExchange filter including fields from INCLUDE, -excluding those from EXCLUDE, using BASE as a base filter. + "Compile INCLUDE and EXCLUDE into a filter derived from BASE. INCLUDE and EXCLUDE must both be lists; BASE should be a symbol or string." |