add docstring of twittering-format-status

* twittering-mode.el (twittering-format-status): add docstring
hayamiz · Jan 13, 2010 · f6506e3 · f6506e3
1 parent a12ee25
commit f6506e3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,7 @@
+2010-01-14  Yuto Hayamizu  <y.hayamizu@gmail.com>
+
+	* twittering-mode.el (twittering-format-status): add docstring
+
 2010-01-13  Tadashi MATSUO  <tad@mymail.twin.jp>
 
 	* twittering-mode.el (twittering-format-string): fix the search of

diff --git a/twittering-mode.el b/twittering-mode.el
@@ -1728,6 +1728,9 @@ following symbols;
     ))
 
 (defun twittering-format-status (status format-str)
+  "Format a string out of a format-str and STATUS.
+Specification of format-str is described in the document for the
+variable `twittering-status-format'"
   (flet ((attr (key)
 	       (assocref key status))
 	 (profile-image