aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Allred <code@seanallred.com>2015-01-01 23:20:34 -0500
committerSean Allred <code@seanallred.com>2015-01-01 23:20:34 -0500
commit80541f53ab81695f5878055ac4404ee212766b11 (patch)
tree2d7b134c0367c6797c6451fbbd606eced6c77007
parent8b5e430d385db04b21b917bb62935e8266819e38 (diff)
Checkdoc
-rw-r--r--sx.el18
1 files changed, 9 insertions, 9 deletions
diff --git a/sx.el b/sx.el
index b31b22f..e6215b4 100644
--- a/sx.el
+++ b/sx.el
@@ -74,7 +74,7 @@ DATA can also be the link itself."
"\\1\\2" link))))
(defun sx--ensure-site (data)
- "Add a `site' property to DATA if it doesn't have one. Return DATA.
+ "Add a `site' property to DATA if it doesn't have one. Return DATA.
DATA can be a question, answer, comment, or user (or any object
with a `link' property)."
(when data
@@ -132,8 +132,9 @@ with a `link' property)."
result))
(defmacro sx-assoc-let (alist &rest body)
- "Identical to `let-alist', except `.site' has a special meaning.
-If ALIST doesn't have a `site' property, one is created using the
+ "Use ALIST with `let-alist' to execute BODY.
+`.site' has a special meaning, thanks to `sx--ensure-site'. If
+ALIST doesn't have a `site' property, one is created using the
`link' property."
(declare (indent 1) (debug t))
(require 'let-alist)
@@ -191,13 +192,12 @@ All ARGS are passed to `completing-read' or `ido-completing-read'."
args))
(defun sx--multiple-read (prompt hist-var)
- "Interactively query gthe user for a list of strings.
+ "Interactively query the user for a list of strings.
Call `read-string' multiple times, until the input is empty.
-PROMPT is a string displayed to the user. and should not
-end with a space nor a colon.
-HIST-VAR is a quoted symbol, indicating a list in which to store
-input history."
+PROMPT is a string displayed to the user and should not end with
+a space nor a colon. HIST-VAR is a quoted symbol, indicating a
+list in which to store input history."
(let (list input)
(while (not (string=
""
@@ -336,7 +336,7 @@ Return the result of BODY."
("ĥ" . "h")
("ĵ" . "j")
("^[:ascii:]" . ""))
- "List of replacements to use for non-ascii characters
+ "List of replacements to use for non-ascii characters.
Used to convert user names into @mentions.")
(defun sx--user-@name (user)