branch: externals/corfu-doc
commit dcc481a5d08c17421cbcfca5aeb1630aff9b43bc
Author: Yuwei Tian <[email protected]>
Commit: Yuwei Tian <[email protected]>
Document display the doc frame within the parent frame
---
README.org | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/README.org b/README.org
index f620559590..9e673e6d6c 100644
--- a/README.org
+++ b/README.org
@@ -50,6 +50,24 @@ Bind a key to quickly toggle the documentation popup on or
off.
(define-key corfu-map (kbd "M-d") #'corfu-doc-toggle)
#+end_src
+** Display the doc frame within the parent frame
+
+You could choose to display the doc frame within the parent frame by setting
+=corfu-doc-display-within-parent-frame= to non-nil. Otherwise, the position of
+the doc frame is calculated base on the size of the display monitor.
+
+#+begin_quote
+Most window-systems clip a child frame at the native edges (see
[[https://www.gnu.org/software/emacs/manual/html_node/elisp/Frame-Geometry.html][Frame
Geometry]])
+of its parent frame—everything outside these edges
+is usually invisible...
+
+NS builds do not clip child frames at the parent frame’s edges,
+allowing them to be positioned so they do not obscure the parent frame while
+still being visible themselves.
+#+end_quote
+
+Please see "(elisp) Child Frames" in Emacs manual for details.
+
* Contributions
This package will be packaged into corfu in the future as an
