From b868a66ccb9cde89d934a896fe3c5629ed007d42 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 2 Apr 2009 02:56:10 +0000 Subject: [PATCH] First batch of signature documentation changes; using default argument syntax where applicable. --- Doc/library/abc.rst | 2 +- Doc/library/aifc.rst | 2 +- Doc/library/asynchat.rst | 4 ++-- Doc/library/atexit.rst | 5 +++-- Doc/library/base64.rst | 8 ++++---- Doc/library/bdb.rst | 12 ++++++------ Doc/library/binascii.rst | 4 ++-- 7 files changed, 19 insertions(+), 18 deletions(-) diff --git a/Doc/library/abc.rst b/Doc/library/abc.rst index 42f508dd634..31bd896564a 100644 --- a/Doc/library/abc.rst +++ b/Doc/library/abc.rst @@ -158,7 +158,7 @@ It also provides the following decorators: multiple-inheritance. -.. function:: abstractproperty(fget[, fset[, fdel[, doc]]]) +.. function:: abstractproperty(fget=None, fset=None, fdel=None, doc=None) A subclass of the built-in :func:`property`, indicating an abstract property. diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst index e3bb51a65c7..182b1217489 100644 --- a/Doc/library/aifc.rst +++ b/Doc/library/aifc.rst @@ -37,7 +37,7 @@ frame size of 4 bytes (2\*2), and a second's worth occupies 2\*2\*44100 bytes Module :mod:`aifc` defines the following function: -.. function:: open(file[, mode]) +.. function:: open(file, mode=None) Open an AIFF or AIFF-C file and return an object instance with methods that are described below. The argument *file* is either a string naming a file or a file diff --git a/Doc/library/asynchat.rst b/Doc/library/asynchat.rst index d4894ea738f..4adaecf32e1 100644 --- a/Doc/library/asynchat.rst +++ b/Doc/library/asynchat.rst @@ -202,7 +202,7 @@ asynchat - Auxiliary Classes and Functions ------------------------------------------ -.. class:: simple_producer(data[, buffer_size=512]) +.. class:: simple_producer(data, buffer_size=512) A :class:`simple_producer` takes a chunk of data and an optional buffer size. Repeated calls to its :meth:`more` method yield successive chunks of @@ -215,7 +215,7 @@ asynchat - Auxiliary Classes and Functions empty string. -.. class:: fifo([list=None]) +.. class:: fifo(list=None) Each channel maintains a :class:`fifo` holding data which has been pushed by the application but not yet popped for writing to the channel. A diff --git a/Doc/library/atexit.rst b/Doc/library/atexit.rst index 11b4120c746..74712ee04fd 100644 --- a/Doc/library/atexit.rst +++ b/Doc/library/atexit.rst @@ -17,7 +17,7 @@ is killed by a signal, when a Python fatal internal error is detected, or when :func:`os._exit` is called. -.. function:: register(func[, *args[, **kargs]]) +.. function:: register(func, *args, **kargs) Register *func* as a function to be executed at termination. Any optional arguments that are to be passed to *func* must be passed as arguments to @@ -48,7 +48,8 @@ is killed by a signal, when a Python fatal internal error is detected, or when .. seealso:: Module :mod:`readline` - Useful example of :mod:`atexit` to read and write :mod:`readline` history files. + Useful example of :mod:`atexit` to read and write :mod:`readline` history + files. .. _atexit-example: diff --git a/Doc/library/base64.rst b/Doc/library/base64.rst index ef9c02ad7a5..1e789537404 100644 --- a/Doc/library/base64.rst +++ b/Doc/library/base64.rst @@ -23,7 +23,7 @@ well as strings, but only using the Base64 standard alphabet. The modern interface provides: -.. function:: b64encode(s[, altchars]) +.. function:: b64encode(s, altchars=None) Encode a string use Base64. @@ -36,7 +36,7 @@ The modern interface provides: The encoded string is returned. -.. function:: b64decode(s[, altchars]) +.. function:: b64decode(s, altchars=None) Decode a Base64 encoded string. @@ -78,7 +78,7 @@ The modern interface provides: is returned. -.. function:: b32decode(s[, casefold[, map01]]) +.. function:: b32decode(s, casefold=False, map01=None) Decode a Base32 encoded string. @@ -105,7 +105,7 @@ The modern interface provides: *s* is the string to encode. The encoded string is returned. -.. function:: b16decode(s[, casefold]) +.. function:: b16decode(s, casefold=False) Decode a Base16 encoded string. diff --git a/Doc/library/bdb.rst b/Doc/library/bdb.rst index 9d75a01894e..3e5fcd67f62 100644 --- a/Doc/library/bdb.rst +++ b/Doc/library/bdb.rst @@ -16,7 +16,7 @@ The following exception is defined: The :mod:`bdb` module also defines two classes: -.. class:: Breakpoint(self, file, line[, temporary=0[, cond=None [, funcname=None]]]) +.. class:: Breakpoint(self, file, line, temporary=0, cond=None, funcname=None) This class implements temporary breakpoints, ignore counts, disabling and (re-)enabling, and conditionals. @@ -50,7 +50,7 @@ The :mod:`bdb` module also defines two classes: Mark the breakpoint as disabled. - .. method:: pprint([out]) + .. method:: bpprint(out=None) Print all the information about the breakpoint: @@ -233,7 +233,7 @@ The :mod:`bdb` module also defines two classes: breakpoints. These methods return a string containing an error message if something went wrong, or ``None`` if all is well. - .. method:: set_break(filename, lineno[, temporary=0[, cond[, funcname]]]) + .. method:: set_break(filename, lineno, temporary=0, cond, funcname) Set a new breakpoint. If the *lineno* line doesn't exist for the *filename* passed as argument, return an error message. The *filename* @@ -285,7 +285,7 @@ The :mod:`bdb` module also defines two classes: Get a list of records for a frame and all higher (calling) and lower frames, and the size of the higher part. - .. method:: format_stack_entry(frame_lineno, [lprefix=': ']) + .. method:: format_stack_entry(frame_lineno, lprefix=': ') Return a string with information about a stack entry, identified by a ``(frame, lineno)`` tuple: @@ -300,12 +300,12 @@ The :mod:`bdb` module also defines two classes: The following two methods can be called by clients to use a debugger to debug a :term:`statement`, given as a string. - .. method:: run(cmd, [globals, [locals]]) + .. method:: run(cmd, globals=None, locals=None) Debug a statement executed via the :func:`exec` function. *globals* defaults to :attr:`__main__.__dict__`, *locals* defaults to *globals*. - .. method:: runeval(expr, [globals, [locals]]) + .. method:: runeval(expr, globals=None, locals=None) Debug an expression executed via the :func:`eval` function. *globals* and *locals* have the same meaning as in :meth:`run`. diff --git a/Doc/library/binascii.rst b/Doc/library/binascii.rst index 83dcb67ec61..dffdd81b6a4 100644 --- a/Doc/library/binascii.rst +++ b/Doc/library/binascii.rst @@ -49,14 +49,14 @@ The :mod:`binascii` module defines the following functions: should be at most 57 to adhere to the base64 standard. -.. function:: a2b_qp(string[, header]) +.. function:: a2b_qp(string, header=False) Convert a block of quoted-printable data back to binary and return the binary data. More than one line may be passed at a time. If the optional argument *header* is present and true, underscores will be decoded as spaces. -.. function:: b2a_qp(data[, quotetabs, istext, header]) +.. function:: b2a_qp(data, quotetabs=False, istext=True, header=False) Convert binary data to a line(s) of ASCII characters in quoted-printable encoding. The return value is the converted line(s). If the optional argument