diff options
| author | Daniel Mendler <mail@daniel-mendler.de> | 2023-09-10 07:59:21 +0200 |
|---|---|---|
| committer | Daniel Mendler <mail@daniel-mendler.de> | 2023-09-10 07:59:21 +0200 |
| commit | cea1ecc901c41239ee35e18dc403e71a40025d4c (patch) | |
| tree | 9738d1100fc85d15d5d226afd0644ce53b89b9fa /cape-char.el | |
| parent | 572697512a6739b06b2d1ad4b05a98060a9c7311 (diff) | |
Improve docstrings
Diffstat (limited to 'cape-char.el')
| -rw-r--r-- | cape-char.el | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/cape-char.el b/cape-char.el index d8571d7..b85a369 100644 --- a/cape-char.el +++ b/cape-char.el @@ -65,8 +65,8 @@ REGEXP is the regular expression matching the names." hash))))) (defmacro cape-char--define (name method &rest prefix) - "Define character translation capf. -NAME is the name of the capf. + "Define character translation Capf. +NAME is the name of the Capf. METHOD is the input method. PREFIX are the prefix characters." (let ((capf (intern (format "cape-%s" name))) @@ -108,13 +108,13 @@ PREFIX are the prefix characters." :exclusive 'no) ,(format "Completion extra properties for `%s'." name)) (defun ,capf (&optional interactive) - ,(format "Complete unicode character at point. + ,(format "Complete Unicode character at point. Uses the same input format as the %s input method, see (describe-input-method %S). If INTERACTIVE -is nil the function acts like a capf." method method) +is nil the function acts like a Capf." method method) (interactive (list t)) (if interactive - ;; NOTE: Disable cycling since replacement breaks it. + ;; No cycling since it breaks the :exit-function. (let (completion-cycle-threshold ,prefix-required) (when (and (memq last-input-event ',prefix) (not (thing-at-point-looking-at ,thing-re))) |