[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/posframe d12d686 04/40: Improve 'posframe-show' documen
From: |
Feng Shu |
Subject: |
[elpa] externals/posframe d12d686 04/40: Improve 'posframe-show' documentation string |
Date: |
Wed, 5 Feb 2020 04:27:16 -0500 (EST) |
branch: externals/posframe
commit d12d6865c84cddaf9156f62ecd48cd3bf1198abd
Author: Štěpán Němec <address@hidden>
Commit: Štěpán Němec <address@hidden>
Improve 'posframe-show' documentation string
* posframe.el (posframe-show): Improve the doc string.
---
posframe.el | 81 ++++++++++++++++++++++++++++++-------------------------------
1 file changed, 40 insertions(+), 41 deletions(-)
diff --git a/posframe.el b/posframe.el
index b68b7d1..e2b7aa0 100644
--- a/posframe.el
+++ b/posframe.el
@@ -337,16 +337,16 @@ This posframe's buffer is POSFRAME-BUFFER."
timeout
refresh
&allow-other-keys)
- "Pop posframe and show STRING at POSITION.
+ "Pop up a posframe and show STRING at POSITION.
POSITION can be:
-1. A integer number, which regard as a point.
-2. A cons of integer, which regard as absolute X and Y.
-3. Other types, User should set POSHANDLER manual to deal
- with them.
+1. An integer, meaning point position.
+2. A cons of two integers, meaning absolute X and Y coordinates.
+3. Other type, in which case the corresponding POSHANDLER should be
+ provided.
-POSHANDLER is a function with one argument, and return
-a real position. its argument is a plist, which like
+POSHANDLER is a function of one argument returning an actual
+position. Its argument is a plist of the following form:
(:position xxx
:position-info xxx
@@ -371,10 +371,10 @@ a real position. its argument is a plist, which like
:x-pixel-offset xxx
:y-pixel-offset xxx)
-by default, poshandler is auto selected based on
-POSITION's type, but user can *force* set one with
-the help of POSHANDLER argument. the below are buildin
-poshandler functions:
+By default, poshandler is auto-selected based on the type of POSITION,
+but the selection can be overridden using the POSHANDLER argument.
+The builtin poshandler functions are listed below:
+
1. `posframe-poshandler-frame-center'
2. `posframe-poshandler-frame-top-center'
3. `posframe-poshandler-frame-top-left-corner'
@@ -392,48 +392,47 @@ poshandler functions:
This posframe's buffer is POSFRAME-BUFFER.
If NO-PROPERTIES is non-nil, The STRING's properties will
-be removed before showed in posframe.
-
-posframe's frame-size can be set by WIDTH and HEIGHT,
-If one of them is nil, posframe's frame-size will fit the
-content of buffer, if you don't want to posframe's
-size too small, MIN-WIDTH and MIN-HEIGTH will be useful
+be removed before being shown in posframe.
-If LEFT-FRINGE or RIGHT-FRINGE is a number, Left fringe or
-right fringe with be showed with number width.
+Posframe's frame size can be set by WIDTH and HEIGHT.
+If one of them is nil, posframe's frame size will fit the
+buffer. MIN-WIDTH and MIN-HEIGTH can be useful to prevent
+posframe becoming too small.
-By default, posframe shows no border, user can let border
-showed by setting INTERNAL-BORDER-WIDTH to a postive number,
-by the way, border's color can be specified by INTERNAL-BORDER-COLOR
-or ‘internal-border’ face.
+If LEFT-FRINGE or RIGHT-FRINGE is a number, left fringe or
+right fringe with be shown with the specified width.
-By default, posframe's font is deriverd from current frame
-user can set posframe's font with FONT argument.
+By default, posframe shows no borders, but users can specify
+borders by setting INTERNAL-BORDER-WIDTH to a positive number.
+Border color can be specified by INTERNAL-BORDER-COLOR
+or via the ‘internal-border’ face.
-By default, posframe's foreground and background color are
-deriverd from current frame, user can set them with the help
-of FOREGROUND-COLOR and BACKGROUND-COLOR.
+Posframe's font as well as foreground and background colors are
+derived from the current frame by default, but can be overridden
+using the FONT, FOREGROUND-COLOR and BACKGROUND-COLOR arguments,
+respectively.
-By default, posframe will force hide header-line and mode-line
-If user want to show header-line or mode-line in posframe,
-set RESPECT-HEADER-LINE or RESPECT-MODE-LINE to t.
+By default, posframe will display no header-line or mode-line.
+In case a header-line or mode-line is desired, users can set
+RESPECT-HEADER-LINE or RESPECT-MODE-LINE to t.
-INITIALIZE is a function with no argument, it will run when
+INITIALIZE is a function with no argument. It will run when
posframe buffer is first selected with `with-current-buffer'
-in posframe-show, and only run once for speed reason, If INITIALIZE
-is nil, `posframe-default-initialize-function' will be used as
-fallback, user can use this variable to global set posframe buffer.
+in `posframe-show', and only run once (for performance reasons).
+If INITIALIZE is nil, `posframe-default-initialize-function' will
+be used as fallback; this variable can be used to set posframe
+buffer gobally.
OVERRIDE-PARAMETERS is very powful, *all* the frame parameters
-used by posframe's frame can be overrided by it.
+used by posframe's frame can be overridden by it.
-If TIMEOUT is a number, a delay of number seconds, the posframe
-will auto hide.
+TIMEOUT can specify the number of seconds after which the posframe
+will auto-hide.
-If REFRESH is a number, posframe's frame-size will be re-adjust
-every mumber seconds.
+If REFRESH is a number, posframe's frame-size will be re-adjusted
+every REFRESH seconds.
-you can use `posframe-delete-all' to delete all posframes."
+You can use `posframe-delete-all' to delete all posframes."
(let* ((position (or (funcall posframe-arghandler posframe-buffer :position
position) (point)))
(poshandler (funcall posframe-arghandler posframe-buffer :poshandler
poshandler))
(width (funcall posframe-arghandler posframe-buffer :width width))
- [elpa] externals/posframe updated (fc90a1a -> c250771), Feng Shu, 2020/02/05
- [elpa] externals/posframe d12d686 04/40: Improve 'posframe-show' documentation string,
Feng Shu <=
- [elpa] externals/posframe 9900f93 06/40: Fix compiler and checkdoc warnings, Feng Shu, 2020/02/05
- [elpa] externals/posframe 3e02422 02/40: Fix compiler and checkdoc warnings, Feng Shu, 2020/02/05
- [elpa] externals/posframe 8242db6 03/40: Autoload the main entry point, Feng Shu, 2020/02/05
- [elpa] externals/posframe 3583a21 05/40: More documentation language improvements, Feng Shu, 2020/02/05
- [elpa] externals/posframe f44d3a5 09/40: Merge pull request #35 from stepnem/fix-warnings, Feng Shu, 2020/02/05
- [elpa] externals/posframe 427318d 01/40: Fix posframe-delete doesn't kill the posframe buffer #39, Feng Shu, 2020/02/05
- [elpa] externals/posframe 9a1a17b 08/40: Fix incorrect current-buffer bug in 'posframe-show', Feng Shu, 2020/02/05
- [elpa] externals/posframe bf5bd24 14/40: Improve logic in 'posframe-funcall', Feng Shu, 2020/02/05
- [elpa] externals/posframe ab72f53 07/40: Autoload the main entry point, Feng Shu, 2020/02/05
- [elpa] externals/posframe 9520893 32/40: Merge pull request #49 from conao3/trivial-fix, Feng Shu, 2020/02/05