mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-07 15:00:34 -08:00
Code Issues Projects Releases Wiki Activity

; Improve wording of documentation of 'hs-cycle-filter'

Browse source 
* doc/emacs/programs.texi (Hideshow):
* etc/NEWS:
* lisp/progmodes/hideshow.el (hs-cycle-filter): Improve wording.
This commit is contained in:
Eli Zaretskii 2025-11-17 17:54:48 +02:00
parent 6c770f8624
commit f81fc11613
3 changed files with 19 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/emacs/programs.texi
View file

@ -1774,10 +1774,12 @@ disabled; the value of @code{nil} will activate the indicators
regardless of the buffer size. regardless of the buffer size.
@item hs-cycle-filter @item hs-cycle-filter
This variable controls where on the line with hideable blocks the This variable controls where on the line with hideable blocks typing the
@kbd{@key{TAB}} key cycles their visibility. Depending on its non-nil @kbd{@key{TAB}} key will cycle the visibility of the blocks. Depending
values, @kbd{@key{TAB}} can be active on different parts of such lines. on its non-@code{nil} value, @key{TAB} can be active on different parts
Anywhere else on the line this key has its default keybinding. of such lines. Anywhere else on the line @key{TAB} has its default key
binding. The value @code{nil} means @key{TAB} cannot cycle the
visibility of the blocks anywhere on the heading line.
@item hs-isearch-open @item hs-isearch-open
This variable specifies the conditions under which incremental search This variable specifies the conditions under which incremental search

4
etc/NEWS
View file

@ -1114,8 +1114,8 @@ after cursor position. By default this is set to 'after-bol'.
+++ +++
*** New user option 'hs-cycle-filter' for visibility-cycling with 'TAB'. *** New user option 'hs-cycle-filter' for visibility-cycling with 'TAB'.
This user option controls where on the line with hideable blocks This user option controls the positions on the headline of hideable blocks
the 'TAB' key cycles their visibility. where the 'TAB' key cycles the blocks' visibility.
+++ +++
*** The variable 'hs-special-modes-alist' is now obsolete. *** The variable 'hs-special-modes-alist' is now obsolete.

20
lisp/progmodes/hideshow.el
View file

@ -469,15 +469,17 @@ info node `(elisp)Overlays'."
:version "28.1") :version "28.1")
(defcustom hs-cycle-filter nil (defcustom hs-cycle-filter nil
"Control where \\`TAB' cycles the visibility. "Control where typing a \\`TAB' cycles the visibility.
This option controls where on a line where a block begins, typing This option determines on which parts of a line where a block
the key sequences bound to the visibility-cycling commands like begins \\`TAB' will be bound to visibility-cycling commands such
`hs-toggle-hiding' will invoke those commands. When t, you can invoke as `hs-toggle-hiding'. The value t means you can type \\`TAB'
these commands by typing \\`TAB' anywhere on a headline. Customizing anywhere on a headline. The value nil means \\`TAB' always has its
this option to other values can make those bindings be in effect only at usual binding. The value can also be a function of no arguments,
specific positions on the headline, like only at the line's beginning or then \\`TAB' will invoke the visibility-cycling commands where that
line's end. This allows these keys to be bound to their usual commands, function returns non-nil. For example, if the value is `bolp',
as determined by the major mode, elsewhere on the headlines." those commands will be invoked at the headline's beginning.
This allows to preserve the usual bindings, as determined by the
major mode, elsewhere on the headlines."
:type `(choice (const :tag "Nowhere" nil) :type `(choice (const :tag "Nowhere" nil)
(const :tag "Everywhere on the headline" t) (const :tag "Everywhere on the headline" t)
(const :tag "At block beginning" (const :tag "At block beginning"