Re: How to avoid infinite recursion in ZLE widgets

[Daniel Shahaf <d.s@xxxxxxxxxxxxxxxxxx>]

Roman Perepelitsa wrote on Sat, 26 Sep 2020 11:40 +0200:
> On Sat, Sep 26, 2020 at 11:27 AM Daniel Shahaf <d.s@xxxxxxxxxxxxxxxxxx> wrote:
> >
> >  Redisplay the command line; this is to be called from within a user-defined
> > -widget to allow changes to become visible.  If a var(display-string) is
> > +widget to allow changes made directly to the terminal (bypassing ZLE) to become
> > +visible.  If a var(display-string) is
> >  given and not empty, this is shown in the status line (immediately
> >  below the line being edited).  
> 
> I think the original documentation was correct. Consider this snippet:

Good point.  However, the language "this is to be called … to allow
changes to become visible" does support Peter's interpretation that «zle
-R» must be called for changes to be shown, so I still think there's
room for clarification.

How about:

diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo
index 84be010e1..c71aa463e 100644
--- a/Doc/Zsh/zle.yo
+++ b/Doc/Zsh/zle.yo
@@ -501,8 +501,7 @@ ifnzman(noderef(Completion Widgets))\
 .
 )
 item(tt(-R) [ tt(-c) ] [ var(display-string) ] [ var(string) ... ])(
-Redisplay the command line; this is to be called from within a user-defined
-widget to allow changes to become visible.  If a var(display-string) is
+Redisplay the command line.  If a var(display-string) is
 given and not empty, this is shown in the status line (immediately
 below the line being edited).
 
@@ -511,9 +510,9 @@ prompt in the same way as completion lists are printed. If no
 var(string)s are given but the tt(-c) option is used such a list is
 cleared.
 
-Note that this option is only useful for widgets that do not exit
-immediately after using it because the strings displayed will be erased 
-immediately after return from the widget.
+Note that immediately after returning from running widgets, the command line
+will be redisplayed and the strings displayed will be erased.  Therefore, this
+option is only useful for widgets that do not exit immediately after using it.
 
 This command can safely be called outside user defined widgets; if zle is
 active, the display will be refreshed, while if zle is not active, the