emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/ement 687a27a886 2/5: Tidy: (ement-directory) Docstring


From: ELPA Syncer
Subject: [elpa] externals/ement 687a27a886 2/5: Tidy: (ement-directory) Docstrings
Date: Fri, 23 Sep 2022 15:57:35 -0400 (EDT)

branch: externals/ement
commit 687a27a886b3bf44ae1145ec48b6fa5f95329c21
Author: Adam Porter <adam@alphapapa.net>
Commit: Adam Porter <adam@alphapapa.net>

    Tidy: (ement-directory) Docstrings
---
 ement-directory.el | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/ement-directory.el b/ement-directory.el
index a9eefe75b6..74a54ad096 100644
--- a/ement-directory.el
+++ b/ement-directory.el
@@ -149,8 +149,8 @@
 
 (cl-defun ement-directory (&key server session (limit 1000))
   "View the public room directory on SERVER with SESSION.
-Interactively, With prefix, prompt for server and number of
-rooms."
+Show up to LIMIT rooms.  Interactively, with prefix, prompt for
+server and LIMIT."
   (interactive (let* ((session (ement-complete-session :prompt "Search on 
session: "))
                       (server (if current-prefix-arg
                                   (read-string "Search on server: " nil nil
@@ -229,7 +229,10 @@ QUERY is a string used to filter results."
                                          (keys ement-directory-default-keys)
                                          (display-buffer-action 
'(display-buffer-same-window)))
   "View RESULTS in an `ement-directory-mode' buffer.
-To be called by `ement-directory-search'."
+Show results for SESSION.  Set buffer's `revert-buffer-function'
+to REVERT-FUNCTION.  Sets BUFFER-NAME and ROOT-SECTION-NAME, and
+uses DISPLAY-BUFFER-ACTION.  KEYS are a list of `taxy' keys.  To
+be called by `ement-directory-search'."
   (let (format-table column-sizes window-start)
     (cl-labels ((format-item (item) (gethash item format-table))
                 ;; NOTE: Since these functions take an "item" (which is a 
[room session]
@@ -301,3 +304,4 @@ To be called by `ement-directory-search'."
 ;;;; Footer
 
 (provide 'ement-directory)
+;;; ement-directory.el ends here



reply via email to

[Prev in Thread] Current Thread [Next in Thread]