vim: runtime/doc/if_pyth.txt comparison

comparison runtime/doc/if_pyth.txt @ 236:4707450c2b33

updated for version 7.0066

author	vimboss
date	Fri, 15 Apr 2005 21:00:38 +0000
parents	4ac1dce8dd5e
children	862863033fdd

comparison

equal deleted inserted replaced

-:23d380e32c95
+:4707450c2b33
-*if_pyth.txt*   For Vim version 7.0aa.  Last change: 2004 Jul 25
+*if_pyth.txt*   For Vim version 7.0aa.  Last change: 2005 Mar 29
 		  VIM REFERENCE MANUAL    by Paul Moore
 ==============================================================================
 2. The vim module					*python-vim*
 Python code gets all of its access to vim (with one exception - see
-|python-output| below) via the "vim" module. The vim module implements two
+|python-output| below) via the "vim" module.  The vim module implements two
 methods, three constants, and one error object.  You need to import the vim
 module before using it: >
 	:python import vim
 Overview >
 Methods of the "vim" module
 vim.command(str)					*python-command*
-	Executes the vim (ex-mode) command str. Returns None.
+	Executes the vim (ex-mode) command str.  Returns None.
 	Examples: >
 	    :py vim.command("set tw=72")
 	    :py vim.command("%s/aaa/bbb/g")
 <	The following definition executes Normal mode commands: >
 		def normal(str):
 	older.  This only works with Python 2.3 and later: >
 	    :py vim.command("python print 'Hello again Python'")
 vim.eval(str)						*python-eval*
 	Evaluates the expression str using the vim internal expression
-	evaluator (see |expression|). Returns the expression result as a
+	evaluator (see |expression|).  Returns the expression result as a
 	string.
 	Examples: >
 	    :py text_width = vim.eval("&tw")
 	    :py str = vim.eval("12+12")		# NB result is a string! Use
 						# string.atoi() to convert to
 	Note that these are not actually constants - you could reassign them.
 	But this is silly, as you would then lose access to the vim objects
 	to which the variables referred.
 vim.buffers						*python-buffers*
-	A sequence object providing access to the list of vim buffers. The
+	A sequence object providing access to the list of vim buffers.  The
 	object supports the following operations: >
 	    :py b = vim.buffers[i]	# Indexing (read-only)
 	    :py b in vim.buffers	# Membership test
 	    :py n = len(vim.buffers)	# Number of elements
 	    :py for b in vim.buffers:	# Sequential access
 <
 vim.windows						*python-windows*
-	A sequence object providing access to the list of vim windows. The
+	A sequence object providing access to the list of vim windows.  The
 	object supports the following operations: >
 	    :py w = vim.windows[i]	# Indexing (read-only)
 	    :py w in vim.windows	# Membership test
 	    :py n = len(vim.windows)	# Number of elements
 	    :py for w in vim.windows:	# Sequential access
 		vim.current.line	The current line (RW)		String
 		vim.current.buffer	The current buffer (RO)		Buffer
 		vim.current.window	The current window (RO)		Window
 		vim.current.range	The current line range (RO)	Range
-	The last case deserves a little explanation. When the :python or
+	The last case deserves a little explanation.  When the :python or
 	:pyfile command specifies a range, this range of lines becomes the
-	"current range". A range is a bit like a buffer, but with all access
+	"current range".  A range is a bit like a buffer, but with all access
-	restricted to a subset of lines. See |python-range| for more details.
+	restricted to a subset of lines.  See |python-range| for more details.
 Output from Python					*python-output*
 	Vim displays all Python code output in the Vim message area.  Normal
 	output appears as information messages, and error output appears as
 	messages, and all output to sys.stderr (including error tracebacks)
 	appears as error messages.
 							*python-input*
 	Input (via sys.stdin, including input() and raw_input()) is not
-	supported, and may cause the program to crash. This should probably be
+	supported, and may cause the program to crash.  This should probably be
 	fixed.
 ==============================================================================
 3. Buffer objects					*python-buffer*
-Buffer objects represent vim buffers. You can obtain them in a number of ways:
+Buffer objects represent vim buffers.  You can obtain them in a number of ways:
 	- via vim.current.buffer (|python-current|)
 	- from indexing vim.buffers (|python-buffers|)
 	- from the "buffer" attribute of a window (|python-window|)
 Buffer objects have one read-only attribute - name - the full file name for
-the buffer. They also have three methods (append, mark, and range; see below).
+the buffer.  They also have three methods (append, mark, and range; see below).
-You can also treat buffer objects as sequence objects. In this context, they
+You can also treat buffer objects as sequence objects.  In this context, they
 act as if they were lists (yes, they are mutable) of strings, with each
-element being a line of the buffer. All of the usual sequence operations,
+element being a line of the buffer.  All of the usual sequence operations,
 including indexing, index assignment, slicing and slice assignment, work as
-you would expect. Note that the result of indexing (slicing) a buffer is a
+you would expect.  Note that the result of indexing (slicing) a buffer is a
-string (list of strings). This has one unusual consequence - b[:] is different
+string (list of strings).  This has one unusual consequence - b[:] is different
-from b. In particular, "b[:] = None" deletes the whole of the buffer, whereas
+from b.  In particular, "b[:] = None" deletes the whole of the buffer, whereas
 "b = None" merely updates the variable b, with no effect on the buffer.
-Buffer indexes start at zero, as is normal in Python. This differs from vim
+Buffer indexes start at zero, as is normal in Python.  This differs from vim
-line numbers, which start from 1. This is particularly relevant when dealing
+line numbers, which start from 1.  This is particularly relevant when dealing
 with marks (see below) which use vim line numbers.
 The buffer object methods are:
 	b.append(str)	Append a line to the buffer
 	b.append(list)	Append a list of lines to the buffer
 	:py r = b.range(1,5)		# a sub-range of the buffer
 ==============================================================================
 4. Range objects					*python-range*
-Range objects represent a part of a vim buffer. You can obtain them in a
+Range objects represent a part of a vim buffer.  You can obtain them in a
 number of ways:
 	- via vim.current.range (|python-current|)
 	- from a buffer's range() method (|python-buffer|)
-A range object is almost identical in operation to a buffer object. However,
+A range object is almost identical in operation to a buffer object.  However,
 all operations are restricted to the lines within the range (this line range
 can, of course, change as a result of slice assignments, line deletions, or
 the range.append() method).
 The range object attributes are:
 	vim.command("%d,%dhardcopy!" % (r.start+1,r.end+1))
 ==============================================================================
 5. Window objects					*python-window*
-Window objects represent vim windows. You can obtain them in a number of ways:
+Window objects represent vim windows.  You can obtain them in a number of ways:
 	- via vim.current.window (|python-current|)
 	- from indexing vim.windows (|python-windows|)
-You can manipulate window objects only through their attributes. They have no
+You can manipulate window objects only through their attributes.  They have no
 methods, and no sequence or other interface.
 Window attributes are:
 	buffer (read-only)	The buffer displayed in this window
 	cursor (read-write)	The current cursor position in the window

Mercurial > vim

comparison runtime/doc/if_pyth.txt @ 236:4707450c2b33