[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/posframe 85c9777 17/40: Touch up some doc strings
From: |
Feng Shu |
Subject: |
[elpa] externals/posframe 85c9777 17/40: Touch up some doc strings |
Date: |
Wed, 5 Feb 2020 04:27:19 -0500 (EST) |
branch: externals/posframe
commit 85c977731c7bbd811f31f6ea652d110a1794047e
Author: Štěpán Němec <address@hidden>
Commit: Štěpán Němec <address@hidden>
Touch up some doc strings
---
posframe.el | 21 +++++++++++++--------
1 file changed, 13 insertions(+), 8 deletions(-)
diff --git a/posframe.el b/posframe.el
index d82c9cc..fbdd9f5 100644
--- a/posframe.el
+++ b/posframe.el
@@ -92,7 +92,7 @@
;; #+BEGIN_EXAMPLE
;; (posframe-delete " *my-posframe-buffer*")
;; #+END_EXAMPLE
-;; 2. Only delete posframe's frame
+;; 2. Only delete the frame
;; #+BEGIN_EXAMPLE
;; (posframe-delete-frame " *my-posframe-buffer*")
;; #+END_EXAMPLE
@@ -671,17 +671,20 @@ BUFFER-OR-NAME can be a buffer or a buffer name."
(with-current-buffer buffer posframe--frame)))
(defun posframe-hide (buffer-or-name)
- "Hide posframe pertaining to BUFFER-OR-NAME."
+ "Hide posframe pertaining to BUFFER-OR-NAME.
+BUFFER-OR-NAME can be a buffer or a buffer name."
(when-let ((frame (posframe-buffer-frame buffer-or-name)))
(posframe--make-frame-invisible frame)))
(defun posframe-delete (buffer-or-name)
- "Delete posframe which buffer BUFFER-OR-NAME."
+ "Delete posframe pertaining to BUFFER-OR-NAME and kill the buffer.
+BUFFER-OR-NAME can be a buffer or a buffer name."
(posframe-delete-frame buffer-or-name)
(posframe--kill-buffer buffer-or-name))
(defun posframe-delete-frame (buffer-or-name)
- "Delete posframe pertaining to BUFFER-OR-NAME."
+ "Delete posframe pertaining to BUFFER-OR-NAME.
+BUFFER-OR-NAME can be a buffer or a buffer name."
(when-let ((buffer (get-buffer buffer-or-name)))
(with-current-buffer buffer
(dolist (timer '(posframe--refresh-timer
@@ -692,12 +695,14 @@ BUFFER-OR-NAME can be a buffer or a buffer name."
(delete-frame posframe--frame)))))
(defun posframe--kill-buffer (buffer-or-name)
- "Kill posframe's buffer: BUFFER-OR-NAME."
+ "Kill posframe's buffer: BUFFER-OR-NAME.
+BUFFER-OR-NAME can be a buffer or a buffer name."
(when (buffer-live-p (get-buffer buffer-or-name))
(kill-buffer buffer-or-name)))
(defun posframe-funcall (buffer-or-name function &rest arguments)
- "Select posframe of BUFFER-OR-NAME and call FUNCTION with ARGUMENTS."
+ "Select posframe of BUFFER-OR-NAME and call FUNCTION with ARGUMENTS.
+BUFFER-OR-NAME can be a buffer or a buffer name."
(when (functionp function)
(when (get-buffer buffer-or-name)
(with-current-buffer buffer-or-name
@@ -707,7 +712,7 @@ BUFFER-OR-NAME can be a buffer or a buffer name."
;;;###autoload
(defun posframe-hide-all ()
- "Hide all posframe's frames."
+ "Hide all posframe frames."
(interactive)
(dolist (frame (frame-list))
(when (frame-parameter frame 'posframe-buffer)
@@ -715,7 +720,7 @@ BUFFER-OR-NAME can be a buffer or a buffer name."
;;;###autoload
(defun posframe-delete-all ()
- "Delete all posframe's frames and buffers."
+ "Delete all posframe frames and buffers."
(interactive)
(dolist (frame (frame-list))
(when (frame-parameter frame 'posframe-buffer)
- [elpa] externals/posframe d504867 33/40: Add posframe-refresh, (continued)
- [elpa] externals/posframe d504867 33/40: Add posframe-refresh, Feng Shu, 2020/02/05
- [elpa] externals/posframe f335f92 24/40: Make the buffer in posframe dedicated, Feng Shu, 2020/02/05
- [elpa] externals/posframe 8108052 20/40: Merge pull request #42 from stepnem/refactor, Feng Shu, 2020/02/05
- [elpa] externals/posframe bb13933 25/40: Merge pull request #47 from yyoncho/master, Feng Shu, 2020/02/05
- [elpa] externals/posframe f390e35 27/40: Fix: Posframe is slow if emacs is built using athena toolkit #45, Feng Shu, 2020/02/05
- [elpa] externals/posframe b44c1ae 31/40: Merge pull request #50 from conao3/add-center-handler, Feng Shu, 2020/02/05
- [elpa] externals/posframe d75dc15 26/40: Fix: Frame not tall enough if line-spacing > 0 #48, Feng Shu, 2020/02/05
- [elpa] externals/posframe 8c636fc 11/40: Merge pull request #41 from stepnem/doc-string, Feng Shu, 2020/02/05
- [elpa] externals/posframe 330cae2 15/40: Improve 'posframe-delete-frame', Feng Shu, 2020/02/05
- [elpa] externals/posframe 46ffb02 12/40: Rename posframe-buffer function parameter to buffer-or-name, Feng Shu, 2020/02/05
- [elpa] externals/posframe 85c9777 17/40: Touch up some doc strings,
Feng Shu <=
- [elpa] externals/posframe dcc281c 34/40: Add some packages which use posframe, as examples., Feng Shu, 2020/02/05
- [elpa] externals/posframe bfd2e55 23/40: Update README, Feng Shu, 2020/02/05
- [elpa] externals/posframe 0e55b2b 37/40: autoload posframe-workable-p, Feng Shu, 2020/02/05
- [elpa] externals/posframe 913b90d 38/40: Fix: ivy-posframe flickering in macos, Feng Shu, 2020/02/05
- [elpa] externals/posframe d495ea9 18/40: posframe--create-posframe: Document return value, Feng Shu, 2020/02/05
- [elpa] externals/posframe c250771 40/40: Remove useless 'and, Feng Shu, 2020/02/05
- [elpa] externals/posframe 5b2e3fc 36/40: Force raise the current posframe., Feng Shu, 2020/02/05
- [elpa] externals/posframe 7bc5857 39/40: Fix: Position for font-height invalid #53, Feng Shu, 2020/02/05