diff options
| author | Sean Allred <code@seanallred.com> | 2014-11-19 10:56:51 -0500 |
|---|---|---|
| committer | Sean Allred <code@seanallred.com> | 2014-11-19 10:56:51 -0500 |
| commit | 56371314c1eb4fede7fbf56b049a65f093af0778 (patch) | |
| tree | 1716faac683ba560af5e9ed92ff96ed03bf260f8 | |
| parent | f694d5ed0bf7d29f83622c041ae30433a7223366 (diff) | |
Enhance documentation
| -rw-r--r-- | sx-question-list.el | 5 | ||||
| -rw-r--r-- | sx-question-mode.el | 7 | ||||
| -rw-r--r-- | sx-question.el | 4 |
3 files changed, 11 insertions, 5 deletions
diff --git a/sx-question-list.el b/sx-question-list.el index c562679..bb60a35 100644 --- a/sx-question-list.el +++ b/sx-question-list.el @@ -210,7 +210,10 @@ Non-interactively, DATA is a question alist." "Site being displayed in the *question-list* buffer.") (defvar sx-question-list--current-dataset nil - "The logical data behind the displayed list of questions.") + "The logical data behind the displayed list of questions. + +This dataset contains even questions that are hidden by the user, +and thus not displayed in the list of questions.") (defun sx-question-list-refresh (&optional redisplay no-update) "Update the list of questions. diff --git a/sx-question-mode.el b/sx-question-mode.el index db9cc8b..4e40e2c 100644 --- a/sx-question-mode.el +++ b/sx-question-mode.el @@ -304,7 +304,7 @@ DATA can represent a question or an answer." (defun sx-question-mode--print-comment (comment-data) "Print the comment described by alist COMMENT-DATA. -The comment is printed according to +The comment is indented, filled, and then printed according to `sx-question-mode-comments-format'." (sx-assoc-let comment-data (insert @@ -356,8 +356,9 @@ ARGS is a list of repeating values -- `header', `value', and `face'. `header' is given `sx-question-mode-header' as a face, where `value' is given `face' as its face. -Use as (fn header value face - [header value face] ...)" +Syntax: + + \(fn HEADER VALUE FACE [HEADER VALUE FACE] [HEADER VALUE FACE] ...)" (while args (insert (propertize (pop args) 'face 'sx-question-mode-header) diff --git a/sx-question.el b/sx-question.el index 344b54c..cccf525 100644 --- a/sx-question.el +++ b/sx-question.el @@ -49,7 +49,9 @@ (defun sx-question-get-questions (site &optional page) "Get the page PAGE of questions from SITE. -Return a list of questions, each consed with (site SITE). +Return a list of question. Each question is an alist of +properties returned by the API with an added (site SITE) +property. `sx-method-call' is used with `sx-question-browse-filter'." (mapcar |