From b3556b21e23eb3381b220e0d3319d94b3a89e0ac Mon Sep 17 00:00:00 2001 From: hut Date: Wed, 13 Jan 2010 05:51:27 +0100 Subject: updated pydoc documentation --- doc/pydoc/ranger.keyapi.html | 58 ++++++++++++++++++++++++++------------------ 1 file changed, 34 insertions(+), 24 deletions(-) (limited to 'doc/pydoc/ranger.keyapi.html') diff --git a/doc/pydoc/ranger.keyapi.html b/doc/pydoc/ranger.keyapi.html index dfb97892..bda4bd02 100644 --- a/doc/pydoc/ranger.keyapi.html +++ b/doc/pydoc/ranger.keyapi.html @@ -9,7 +9,19 @@  
ranger.keyapiindex
/home/hut/work/ranger/ranger/keyapi.py -

+

# Copyright (c) 2009, 2010 hut <hut@lavabit.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

@@ -30,7 +42,6 @@
Wrapper -
nwrap
@@ -46,26 +57,6 @@
__init__(self, firstattr)
-
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class nwrap(builtins.object)
   # Another wrapper for common actions which use a numerical argument:
 
 Static methods defined here:
-
move(relative=0, absolute=None, pages=False)
-
Data descriptors defined here:
__dict__
@@ -119,6 +110,13 @@ Data descriptors defined here:
mouseinterval(...)
mousemask(...)
napms(...)
+
narg(number_, function_, *args_, **keywords_)
This applies the replace_narg function to the arguments and keywords
+and directly runs this function.
+ 
+Example:
+def foo(xyz, narg): return hash((xyz, narg))
+ 
+narg(50, foo, 123) == foo(123, narg=50)
newpad(...)
newwin(...)
nl(...)
@@ -132,6 +130,17 @@ Data descriptors defined here:
putp(...)
qiflush(...)
raw(...)
+
replace_narg(number, function, args, keywords)
This function returns (args, keywords) with one little change:
+if <function> has a named argument called "narg", args and keywords
+will be modified so that the value of "narg" will be <number>.
+ 
+def foo(xyz, narg): pass
+ 
+replace_narg(666, foo, (), {'narg': 10, 'xyz': 5})
+=> (), {'narg': 666, 'xyz': 5}
+ 
+replace_narg(666, foo, (1, 2), {})
+=> (1, 666), {}
reset_prog_mode(...)
reset_shell_mode(...)
resetty(...)
@@ -390,6 +399,7 @@ Data descriptors defined here:
KEY_UP = 259
LF = 10
NAK = 21
+NARG_KEYWORD = 'narg'
NL = 10
NUL = 0
OK = 0
@@ -407,7 +417,7 @@ Data descriptors defined here:
US = 31
VT = 11
controlnames = ['NUL', 'SOH', 'STX', 'ETX', 'EOT', 'ENQ', 'ACK', 'BEL', 'BS', 'HT', 'LF', 'VT', 'FF', 'CR', 'SO', 'SI', 'DLE', 'DC1', 'DC2', 'DC3', ...]
-fm = <ranger.keyapi.Wrapper object at 0x7f20a5b429d0>
+fm = <ranger.keyapi.Wrapper object at 0x1884110>
version = b'2.2'
-wdg = <ranger.keyapi.Wrapper object at 0x7f20a5b42a10>
+wdg = <ranger.keyapi.Wrapper object at 0x1884150> \ No newline at end of file -- cgit 1.4.1-2-gfad0