Merge pull request #77 from vermiculus/documentation

Documentation

1 files changed, 6 insertions, 4 deletions

diff --git a/sx-site.el b/sx-site.el
index 6bef91f..66d78dc 100644
--- a/sx-site.el
+++ b/sx-site.el
@@ -19,8 +19,6 @@
 
 ;;; Commentary:
 
-;;
-
 ;;; Code:
 
 (require 'sx-method)
@@ -43,9 +41,11 @@
      related_site.api_site_parameter
      related_site.relation)
     nil
-    none))
+    none)
+  "Filter for browsing sites.")
 
 (defun sx-site--get-site-list ()
+  "Return all sites with `sx-site-browse-filter'."
   (sx-cache-get
    'site-list
    '(sx-method-call
@@ -54,7 +54,9 @@
 
 (defcustom sx-site-favorites
   nil
-  "Favorite sites."
+  "List of favorite sites.
+Each entry is a string corresponding to a single site's
+api_site_parameter."
   :group 'sx-site)
 
 (defun sx-site-get-api-tokens ()