vim: runtime/doc/eval.txt comparison

comparison runtime/doc/eval.txt @ 1668:0b796e045c42 v7.2b.000

updated for version 7.2b-000

author	vimboss
date	Sun, 13 Jul 2008 17:41:49 +0000
parents	5bbc2d6658ad
children	f4f8014d516e

comparison

equal deleted inserted replaced

-:131dbd3d2a4b
+:0b796e045c42
-*eval.txt*	For Vim version 7.2a.  Last change: 2008 Jun 24
+*eval.txt*	For Vim version 7.2b.  Last change: 2008 Jul 09
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
 					|user-functions|).
 			varname		internal variable (see
 					|internal-variables|).	Also works
 					for |curly-braces-names|, |Dictionary|
 					entries, |List| items, etc.  Beware
-					that this may cause functions to be
+					that evaluating an index may cause an
-					invoked cause an error message for an
+					error message for an invalid
-					invalid expression.
+					expression.  E.g.: >
+					   :let l = [1, 2, 3]
+					   :echo exists("l[5]")
+<					   0 >
+					   :echo exists("l[xx]")
+<					   E121: Undefined variable: xx
+					   0
 			:cmdname	Ex command: built-in command, user
 					command or command modifier |:command|.
 					Returns:
 					1  for match with start of a command
 					2  full match with a command
 getbufvar({expr}, {varname})				*getbufvar()*
 		The result is the value of option or local buffer variable
 		{varname} in buffer {expr}.  Note that the name without "b:"
 		must be used.
+		When {varname} is empty returns a dictionary with all the
+		buffer-local variables.
 		This also works for a global or buffer-local option, but it
 		doesn't work for a global variable, window-local variable or
 		window-local option.
 		For the use of {expr}, see |bufname()| above.
 		When the buffer or variable doesn't exist an empty string is
 		The "**" item can be used to search in a directory tree.
 		For example, to find all "README.txt" files in the directories
 		in 'runtimepath' and below: >
 			:echo globpath(&rtp, "**/README.txt")
-<
+<		Upwards search and limiting the depth of "**" is not
+		supported, thus using 'path' will not always work properly.
 							*has()*
 has({feature})	The result is a Number, which is 1 if the feature {feature} is
 		supported, zero otherwise.  The {feature} argument is a
 		string.  See |feature-list| below.
 		Also see |exists()|.
 histdel({history} [, {item}])				*histdel()*
 		Clear {history}, i.e. delete all its entries.  See |hist-names|
 		for the possible values of {history}.
-		If the parameter {item} is given as String, this is seen
+		If the parameter {item} evaluates to a String, it is used as a
-		as regular expression.	All entries matching that expression
+		regular expression.  All entries matching that expression will
-		will be removed from the history (if there are any).
+		be removed from the history (if there are any).
 		Upper/lowercase must match, unless "\c" is used |/\c|.
-		If {item} is a Number, it will be interpreted as index, see
+		If {item} evaluates to a Number, it will be interpreted as
-		|:history-indexing|.  The respective entry will be removed
+		an index, see |:history-indexing|.  The respective entry will
-		if it exists.
+		be removed if it exists.
 		The result is a Number: 1 for a successful operation,
 		otherwise 0 is returned.
 		Examples:
 							*printf-%*
 		%	A '%' is written.  No argument is converted.  The
 			complete conversion specification is "%%".
-		Each argument can be Number or String and is converted
+		When a Number argument is expected a String argument is also
-		automatically to fit the conversion specifier.	Any other
+		accepted and automatically converted.
-		argument type results in an error message.
+		When a Float or String argument is expected a Number argument
+		is also accepted and automatically converted.
+		Any other argument type results in an error message.
 							*E766* *E767*
 		The number of {exprN} arguments must exactly match the number
 		of "%" items.  If there are not sufficient or too many
 		arguments an error is given.  Up to 18 arguments can be used.
 		{list}.
 		If you want a list to remain unmodified make a copy first: >
 			:let revlist = reverse(copy(mylist))
 round({expr})							*round()*
-		Round off {expr} to a the nearest integral value and return it
+		Round off {expr} to the nearest integral value and return it
 		as a |Float|.  If {expr} lies halfway between two integral
 		values, then use the larger one (away from zero).
 		{expr} must evaluate to a |Float| or a |Number|.
 		Examples: >
 			echo round(0.456)
 		Examples: >
 			:echo sqrt(100)
 <			10.0 >
 			:echo sqrt(-4.01)
 <			nan
+		"nan" may be different, it depends on system libraries.
 		{only available when compiled with the |+float| feature}
 str2float( {expr})					*str2float()*
 		Convert String {expr} to a Float.  This mostly works the same
 <		returns "Hello THere" >
 			echo tr("<blob>", "<>", "{}")
 <		returns "{blob}"
 trunc({expr})							*trunc()*
-		Return the largest integral value with magnituted less than or
+		Return the largest integral value with magnitude less than or
 		equal to {expr} as a |Float| (truncate towards zero).
 		{expr} must evaluate to a |Float| or a |Number|.
 		Examples: >
 			echo trunc(1.456)
 <			1.0  >
 				:unlet list[3]	  " remove fourth item
 				:unlet list[3:]   " remove fourth item to last
 <			One item from a |Dictionary| can be removed at a time: >
 				:unlet dict['two']
 				:unlet dict.two
+<			This is especially useful to clean up used global
+			variables and script-local variables (these are not
+			deleted when the script ends).  Function-local
+			variables are automatically deleted when the function
+			ends.
 :lockv[ar][!] [depth] {name} ...			*:lockvar* *:lockv*
 			Lock the internal variable {name}.  Locking means that
 			it can no longer be changed (until it is unlocked).
 			A locked variable can be deleted: >

Mercurial > vim

comparison runtime/doc/eval.txt @ 1668:0b796e045c42 v7.2b.000