aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii2017-12-16 12:15:06 +0200
committerEli Zaretskii2017-12-16 12:15:06 +0200
commit78908644131e70f20de28fed08ef4dc2878878a3 (patch)
treeebf19e9d28cd1ae021d90964aafc645e0470d600 /doc
parenta1327bbc645efa42f14024785da4fed88aa7ec21 (diff)
downloademacs-78908644131e70f20de28fed08ef4dc2878878a3.tar.gz
emacs-78908644131e70f20de28fed08ef4dc2878878a3.zip
Improve documentation of 'invisible-p'
* doc/lispref/display.texi (Invisible Text): Document the return value of 'invisible-p'. * src/xdisp.c (Finvisible_p): Rename the argument POS. Doc fix. (Bug#29721)
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/display.texi7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 7af8d9efb7c..50069e3d1da 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -929,13 +929,18 @@ major mode should use the mode's own name as an element of
929 929
930@defun invisible-p pos-or-prop 930@defun invisible-p pos-or-prop
931If @var{pos-or-prop} is a marker or number, this function returns a 931If @var{pos-or-prop} is a marker or number, this function returns a
932non-@code{nil} value if the text at that position is invisible. 932non-@code{nil} value if the text at that position is currently
933invisible.
933 934
934If @var{pos-or-prop} is any other kind of Lisp object, that is taken 935If @var{pos-or-prop} is any other kind of Lisp object, that is taken
935to mean a possible value of the @code{invisible} text or overlay 936to mean a possible value of the @code{invisible} text or overlay
936property. In that case, this function returns a non-@code{nil} value 937property. In that case, this function returns a non-@code{nil} value
937if that value would cause text to become invisible, based on the 938if that value would cause text to become invisible, based on the
938current value of @code{buffer-invisibility-spec}. 939current value of @code{buffer-invisibility-spec}.
940
941The return value of this function is @code{t} if the text would be
942completely hidden on display, or a non-@code{nil}, non-@code{t} value
943if the text would be replaced by an ellipsis.
939@end defun 944@end defun
940 945
941@vindex line-move-ignore-invisible 946@vindex line-move-ignore-invisible