Skip to content

Commit

Permalink
Edit doc string prose; link to Info node
Browse files Browse the repository at this point in the history
  • Loading branch information
greghendershott committed Oct 22, 2024
1 parent 0ba692d commit 7ea7779
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions racket-complete.el
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,10 @@ displaying inappropriate annotations."
(complete-with-action action completions prefix predicate)))))

(defun racket--make-affix (specs &optional prop)
"Make an :affixation-function that aligns suffix columns.
"Make an affixation-function to show completion annotations.
For more information about affixation-function completion
metadata, see Info node `(elisp)Programmed Completion'.
PROP is the symbol name of a text property that must be attached
to each of the completion candidate strings. The value of the
Expand All @@ -109,12 +112,14 @@ completions-anntoations. An explicit nil value in the spec means
not to add a face, because the string is already propertized with
one.
Arrange for each suffix column to be aligned, considering the
minimum width and the maximum width of the previous column.
The affixation-function arranges for each suffix column to be
aligned, considering the minimum width and the maximum width of
the previous column.
When the STRS end in text made invisible by a \\='display \"\"
property -- as is done by `racket--doc-index-make-alist' --
ignore that for purposes of calculating widths."
When a candidate string ends with text made invisible by a
\\='display \"\" property -- as is done by
`racket--doc-index-make-alist' -- that text is ignored for
purposes of calculating widths."
;; Note: Below we use `cl-loop' because `seq-do-indexed' and
;; `seq-map-indexed' are unavailable in Emacs 25.
(let ((min-widths (cl-loop
Expand Down

0 comments on commit 7ea7779

Please sign in to comment.