vim: runtime/doc/eval.txt comparison

comparison runtime/doc/eval.txt @ 23666:96206643bd9f

Update runtime files. Commit: https://github.com/vim/vim/commit/98a29d00a48e15a50e2850e1a29b7d475c531b0c Author: Bram Moolenaar <Bram@vim.org> Date: Mon Jan 18 19:55:44 2021 +0100 Update runtime files.

author	Bram Moolenaar <Bram@vim.org>
date	Mon, 18 Jan 2021 20:00:09 +0100
parents	1816ea68c022
children	cd06cc37f53f

comparison

equal deleted inserted replaced

-:f22b9e522fb3
+:96206643bd9f
-*eval.txt*	For Vim version 8.2.  Last change: 2021 Jan 13
+*eval.txt*	For Vim version 8.2.  Last change: 2021 Jan 17
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
 		Note: on MS-Windows it is not possible to delete a directory
 		that is being used.
 		A symbolic link itself is deleted, not what it points to.
-		The result is a Number, which is 0 if the delete operation was
+		The result is a Number, which is 0/false if the delete
-		successful and -1 when the deletion failed or partly failed.
+		operation was successful and -1/true when the deletion failed
+		or partly failed.
 		Use |remove()| to delete an item from a |List|.
 		To delete a line from the buffer use |:delete| or
 		|deletebufline()|.
 <		If the `endif` would be moved to the second line as "| endif" it
 		would not be found.
 has_key({dict}, {key})					*has_key()*
-		The result is a Number, which is 1 if |Dictionary| {dict} has
+		The result is a Number, which is TRUE if |Dictionary| {dict}
-		an entry with key {key}.  Zero otherwise.
+		has an entry with key {key}.  FALSE otherwise.
 		Can also be used as a |method|: >
 			mydict->has_key(key)
 haslocaldir([{winnr} [, {tabnr}]])			*haslocaldir()*
 <
 		Can also be used as a |method|: >
 			GetWinnr()->haslocaldir()
 hasmapto({what} [, {mode} [, {abbr}]])			*hasmapto()*
-		The result is a Number, which is 1 if there is a mapping that
+		The result is a Number, which is TRUE if there is a mapping
-		contains {what} in somewhere in the rhs (what it is mapped to)
+		that contains {what} in somewhere in the rhs (what it is
-		and this mapping exists in one of the modes indicated by
+		mapped to) and this mapping exists in one of the modes
-		{mode}.
+		indicated by {mode}.
 		When {abbr} is there and it is |TRUE| use abbreviations
 		instead of mappings.  Don't forget to specify Insert and/or
 		Command-line mode.
 		Both the global mappings and the mappings local to the current
 		buffer are checked for a match.
-		If no matching mapping is found 0 is returned.
+		If no matching mapping is found FALSE is returned.
 		The following characters are recognized in {mode}:
 			n	Normal mode
 			v	Visual and Select mode
 			x	Visual mode
 			s	Select mode
 			empty		  the current or last used history
 		The {history} string does not need to be the whole name, one
 		character is sufficient.
 		If {item} does already exist in the history, it will be
 		shifted to become the newest entry.
-		The result is a Number: 1 if the operation was successful,
+		The result is a Number: TRUE if the operation was successful,
-		otherwise 0 is returned.
+		otherwise FALSE is returned.
 		Example: >
 			:call histadd("input", strftime("%Y %b %d"))
 			:let date=input("Enter date: ")
 <		This function is not available in the |sandbox|.
 		Upper/lowercase must match, unless "\c" is used |/\c|.
 		If {item} evaluates to a Number, it will be interpreted as
 		an index, see |:history-indexing|.  The respective entry will
 		be removed if it exists.
-		The result is a Number: 1 for a successful operation,
+		The result is TRUE for a successful operation, otherwise FALSE
-		otherwise 0 is returned.
+		is returned.
 		Examples:
 		Clear expression register history: >
 			:call histdel("expr")
 <
 <		Can also be used as a |method|: >
 			GetHistory()->histnr()
 <
 hlexists({name})					*hlexists()*
-		The result is a Number, which is non-zero if a highlight group
+		The result is a Number, which is TRUE if a highlight group
 		called {name} exists.  This is when the group has been
 		defined in some way.  Not necessarily when highlighting has
 		been defined for it, it may also have been used for a syntax
 		item.
 							*highlight_exists()*
 inputrestore()						*inputrestore()*
 		Restore typeahead that was saved with a previous |inputsave()|.
 		Should be called the same number of times inputsave() is
 		called.  Calling it more often is harmless though.
-		Returns 1 when there is nothing to restore, 0 otherwise.
+		Returns TRUE when there is nothing to restore, FALSE otherwise.
 inputsave()						*inputsave()*
 		Preserve typeahead (also from mappings) and clear it, so that
 		a following prompt gets input from the user.  Should be
 		followed by a matching inputrestore() after the prompt.  Can
 		be used several times, in which case there must be just as
 		many inputrestore() calls.
-		Returns 1 when out of memory, 0 otherwise.
+		Returns TRUE when out of memory, FALSE otherwise.
 inputsecret({prompt} [, {text}])			*inputsecret()*
 		This function acts much like the |input()| function with but
 		two exceptions:
 		a) the user's response will be displayed as a sequence of
 		Can also be used as a |method|: >
 			GetBuffer()->listener_flush()
 listener_remove({id})					*listener_remove()*
 		Remove a listener previously added with listener_add().
-		Returns zero when {id} could not be found, one when {id} was
+		Returns FALSE when {id} could not be found, TRUE when {id} was
 		removed.
 		Can also be used as a |method|: >
 			GetListenerId()->listener_remove()
 		There is no error if the directory already exists and the "p"
 		flag is passed (since patch 8.0.1708).  However, without the
 		"p" option the call will fail.
-		The function result is a Number, which is 1 if the call was
+		The function result is a Number, which is TRUE if the call was
-		successful or 0 if the directory creation failed or partly
+		successful or FALSE if the directory creation failed or partly
 		failed.
 		Not available on all systems.  To check use: >
 			:if exists("*mkdir")
 server2client({clientid}, {string})			*server2client()*
 		Send a reply string to {clientid}.  The most recent {clientid}
 		that sent a string can be retrieved with expand("<client>").
 		{only available when compiled with the |+clientserver| feature}
+		Returns zero for success, -1 for failure.
 		Note:
 		This id has to be stored before the next command can be
 		received.  I.e. before returning from the received command and
 		before calling any commands that waits for input.
 		See also |clientserver|.
 		set after the command line is set to the expression.  For
 		|c_CTRL-R_=| it is set after evaluating the expression but
 		before inserting the resulting text.
 		When the number is too big the cursor is put at the end of the
 		line.  A number smaller than one has undefined results.
-		Returns 0 when successful, 1 when not editing the command
+		Returns FALSE when successful, TRUE when not editing the
-		line.
+		command line.
 		Can also be used as a |method|: >
 			GetPos()->setcmdpos()
 setcursorcharpos({lnum}, {col} [, {off}])		*setcursorcharpos()*
 		{lnum} is used like with |getline()|.
 		When {lnum} is just below the last line the {text} will be
 		added below the last line.
-		If this succeeds, 0 is returned.  If this fails (most likely
+		If this succeeds, FALSE is returned.  If this fails (most likely
-		because {lnum} is invalid) 1 is returned.
+		because {lnum} is invalid) TRUE is returned.
 		Example: >
 			:call setline(5, strftime("%c"))
 <		When {text} is a |List| then line {lnum} and following lines
 win_gotoid({expr})					*win_gotoid()*
 		Go to window with ID {expr}.  This may also change the current
 		tabpage.
-		Return 1 if successful, 0 if the window cannot be found.
+		Return TRUE if successful, FALSE if the window cannot be found.
 		Can also be used as a |method|: >
 			GetWinid()->win_gotoid()
 win_id2tabwin({expr})					*win_id2tabwin()*

Mercurial > vim

comparison runtime/doc/eval.txt @ 23666:96206643bd9f