swiper.el: Add docstring

diff --git a/swiper.el b/swiper.el
index b52d0fe8481c61dd56f48d6dfede44a227e84282..6c22e48353c73d45a6546c093bcdaad14167a019 100644 (file)
--- a/swiper.el
+++ b/swiper.el
@@ -317,7 +317,8 @@ When non-nil, INITIAL-INPUT is the initial search pattern."
 (declare-function string-trim-right "subr-x")
 
 (defun swiper-occur (&optional revert)
-  "Generate a custom occur buffer for `swiper'."
+  "Generate a custom occur buffer for `swiper'.
+When REVERT is non-nil, regenerate the current *ivy-occur* buffer."
   (let* ((buffer (ivy-state-buffer ivy-last))
          (fname (propertize
                  (with-ivy-window