; And yet another fix to eglot-current-linepos-function's docstring

bug#61726

* lisp/progmodes/eglot.el (eglot-current-linepos-function):
Another fix.
This commit is contained in:
João Távora 2023-02-27 11:04:44 +00:00
parent 9d0f856a16
commit 647e40f4a0

View file

@ -1453,11 +1453,15 @@ CONNECT-ARGS are passed as additional arguments to
(defvar eglot-current-linepos-function #'eglot-utf-16-linepos (defvar eglot-current-linepos-function #'eglot-utf-16-linepos
"Function calculating position relative to line beginning. "Function calculating position relative to line beginning.
This is the inverse of `eglot-move-to-linepos-function' (which see). It is a function of no arguments considering the text from line
It is a function of no arguments returning the number of code units beginning up to current point. The return value is the number of
or bytes or codepoints corresponding to the current position of point, UTF code units needed to encode that text from the LSP server's
relative to line beginning, as expected by the function that is the perspective. This may be a number of octets, 16-bit words or
value of `eglot-move-to-linepos-function'.") Unicode code points, depending on whether the LSP server's
`positionEncoding' capability is UTF-8, UTF-16 or UTF-32,
respectively. Position of point should remain unaltered if that
return value is fed through the corresponding inverse function
`eglot-move-to-linepos-function' (which see).")
(defun eglot-utf-8-linepos () (defun eglot-utf-8-linepos ()
"Calculate number of UTF-8 bytes from line beginning." "Calculate number of UTF-8 bytes from line beginning."