vim-patch:589edb340454

Updte runtime files

589edb3404

Co-authored-by: Bram Moolenaar <Bram@vim.org>

runtime/doc/builtin.txt

@@ -7374,22 +7374,25 @@ state([{what}])                                                        *state()*
 		current state.  Mostly useful in callbacks that want to do
 		work that may not always be safe.  Roughly this works like:
 		- callback uses state() to check if work is safe to do.
-		  If yes, then do it right away.
+		  Yes: then do it right away.
-		  Otherwise add to work queue and add SafeState autocommand.
+		  No:  add to work queue and add a |SafeState| autocommand.
-		- When SafeState is triggered, check with state() if the work
+		- When SafeState is triggered and executes your autocommand,
-		  can be done now, and if yes remove it from the queue and
+		  check with `state()` if the work can be done now, and if yes
-		  execute.
+		  remove it from the queue and execute.
+		  Remove the autocommand if the queue is now empty.
 		Also see |mode()|.
 
 		When {what} is given only characters in this string will be
 		added.  E.g, this checks if the screen has scrolled: >vim
-			if state('s') != ''
+			if state('s') == ''
+			   " screen has not scrolled
 
 		These characters indicate the state, generally indicating that
 		something is busy:
 		    m	halfway a mapping, :normal command, feedkeys() or
 			stuffed command
-		    o  operator pending or waiting for a command argument
+		    o	operator pending or waiting for a command argument,
+			e.g. after |f|
 		    a	Insert mode autocomplete active
 		    x	executing an autocommand
 		    S	not triggering SafeState

runtime/lua/vim/_meta/vimfn.lua

@@ -8749,22 +8749,25 @@ function vim.fn.srand(expr) end
 --- current state.  Mostly useful in callbacks that want to do
 --- work that may not always be safe.  Roughly this works like:
 --- - callback uses state() to check if work is safe to do.
----   If yes, then do it right away.
+---   Yes: then do it right away.
----   Otherwise add to work queue and add SafeState autocommand.
+---   No:  add to work queue and add a |SafeState| autocommand.
---- - When SafeState is triggered, check with state() if the work
+--- - When SafeState is triggered and executes your autocommand,
----   can be done now, and if yes remove it from the queue and
+---   check with `state()` if the work can be done now, and if yes
----   execute.
+---   remove it from the queue and execute.
+---   Remove the autocommand if the queue is now empty.
 --- Also see |mode()|.
 ---
 --- When {what} is given only characters in this string will be
 --- added.  E.g, this checks if the screen has scrolled: >vim
----   if state('s') != ''
+---   if state('s') == ''
+---      " screen has not scrolled
 ---
 --- These characters indicate the state, generally indicating that
 --- something is busy:
 ---     m  halfway a mapping, :normal command, feedkeys() or
 ---   stuffed command
----     o  operator pending or waiting for a command argument
+---     o  operator pending or waiting for a command argument,
+---   e.g. after |f|
 ---     a  Insert mode autocomplete active
 ---     x  executing an autocommand
 ---     S  not triggering SafeState

src/nvim/eval.lua

@@ -10460,22 +10460,25 @@ M.funcs = {
       current state.  Mostly useful in callbacks that want to do
       work that may not always be safe.  Roughly this works like:
       - callback uses state() to check if work is safe to do.
-        If yes, then do it right away.
+        Yes: then do it right away.
-        Otherwise add to work queue and add SafeState autocommand.
+        No:  add to work queue and add a |SafeState| autocommand.
-      - When SafeState is triggered, check with state() if the work
+      - When SafeState is triggered and executes your autocommand,
-        can be done now, and if yes remove it from the queue and
+        check with `state()` if the work can be done now, and if yes
-        execute.
+        remove it from the queue and execute.
+        Remove the autocommand if the queue is now empty.
       Also see |mode()|.
 
       When {what} is given only characters in this string will be
       added.  E.g, this checks if the screen has scrolled: >vim
-      	if state('s') != ''
+      	if state('s') == ''
+      	   " screen has not scrolled
 
       These characters indicate the state, generally indicating that
       something is busy:
           m	halfway a mapping, :normal command, feedkeys() or
       	stuffed command
-          o  operator pending or waiting for a command argument
+          o	operator pending or waiting for a command argument,
+      	e.g. after |f|
           a	Insert mode autocomplete active
           x	executing an autocommand
           S	not triggering SafeState