branch: externals/company
commit 6697c2e9b823625cb78fc6eda7611e9e4a112787
Merge: 5bdbde05655 405795d5be2
Author: Dmitry Gutov <[email protected]>
Commit: GitHub <[email protected]>
Merge pull request #1545 from yugaego/doc
Editorial documentation changes
---
doc/company.texi | 36 ++++++++++++++++++++++++++----------
1 file changed, 26 insertions(+), 10 deletions(-)
diff --git a/doc/company.texi b/doc/company.texi
index b8bb7917d85..6454f8ad742 100644
--- a/doc/company.texi
+++ b/doc/company.texi
@@ -293,7 +293,7 @@ Hit @key{RET} to choose a selected candidate for completion.
@kindex TAB
Hit @key{TAB} to expand the @dfn{common part} of all completions.
Exactly what that means, can vary by backend. In the simplest case
-it's the longest string that all completion start with, but when a
+it is the longest string that all completion start with, but when a
backend returns @emph{non-prefix matches}, it can implement the same
kind of expansion logic for the input string.
@@ -626,13 +626,23 @@ This group of frontends displays completion candidates in
a
rectangular tooltip (aka @w{popup}). Company provides multiple
@emph{tooltip frontends}, listed below.
-@subheading Childframe Frontends
+@menu
+* Childframe Frontends::
+* Pseudo-Tooltip Frontends::
+* User Options::
+* Candidates Icons::
+* Faces::
+@end menu
-The ``childframe'' family of frontends natually uses a special frame
+@node Childframe Frontends
+@subsection Childframe Frontends
+
+@cindex childframe
+The ``childframe'' family of frontends naturally uses a special frame
to show the popup above the buffer. It can cross window boundaries
-and works in the minibuffer. On some builds it's implemented using
-X11 child windows, and uses native widgets on others. It also works in
-the terminal starting with Emacs 31.
+and works in the minibuffer. On some builds it is implemented using
+X11 child windows, while on others it uses native widgets. It also
+works in the terminal starting with Emacs 31.
@defun company-childframe-unless-just-one-frontend
This is one of the default frontends (except in Emacs<31.1 under X11).
@@ -647,8 +657,10 @@ This frontend shows its tooltip for any number of
completion
candidates. It is the basic version that related frontends extend.
@end defun
-@subheading Pseudo-Tooltip Frontends
+@node Pseudo-Tooltip Frontends
+@subsection Pseudo-Tooltip Frontends
+@cindex pseudo-tooltip
The ``pseudo-tooltip'' family of frontends uses ``overlays'' (a
display engine feature) to render the popup inside the buffer. It has
a stable and fast implementation, with known caveats: it is limited to
@@ -698,7 +710,8 @@ following example:
@end lisp
@end defun
-@subheading User Options
+@node User Options
+@subsection User Options
@macro img{name}
@ifnothtml
@@ -844,7 +857,8 @@ inner area. If @code{company-format-margin-function} is
set,
@img{tooltip-margin}
@end defopt
-@subheading Candidates Icons
+@node Candidates Icons
+@subsection Candidates Icons
@cindex icon
@cindex kind
@@ -937,7 +951,9 @@ the @w{@code{company-vscode-*-icons-margin}} functions if
@w{@code{company-text-icons-margin}} function.
@end defun
-@subheading Faces
+@node Faces
+@subsection Faces
+
@cindex company-tooltip
@cindex face
@cindex font
