branch: externals/posframe
commit fc8c45ba8059da2a5cac10e95df399c2ada890fe
Author: Feng Shu <[email protected]>
Commit: Feng Shu <[email protected]>
* posframe.el (posframe-show): Update docstring about poshandler.
---
posframe.el | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/posframe.el b/posframe.el
index 93d232a..b5c4203 100644
--- a/posframe.el
+++ b/posframe.el
@@ -362,7 +362,19 @@ position. Its argument is a plist of the following form:
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:
+
+The name of poshandler function is like:
+
+ posframe-poshandler-p0.5p0-to-w0.5p1
+
+which mean is that posframe(a, b) align to a position(a, b):
+
+1. a = 0.5 * posframe-width
+2. b = 0 * posframe-height
+3. c = 0.5 * window-width
+4. d = 1 * point-height
+
+The alias of builtin poshandler functions are listed below:
1. `posframe-poshandler-frame-center'
2. `posframe-poshandler-frame-top-center'
