[Python-checkins] r68219 - in python/trunk/Doc: c-api/file.rst distutils/uploading.rst documenting/markup.rst library/ast.rst library/configparser.rst library/ctypes.rst library/decimal.rst library/fractions.rst library/repr.rst library/socketserver.rst library/tempfile.rst
georg.brandl
python-checkins at python.org
Sat Jan 3 21:47:01 CET 2009
Author: georg.brandl
Date: Sat Jan 3 21:47:01 2009
New Revision: 68219
Log:
Fix uses of the default role.
Modified:
python/trunk/Doc/c-api/file.rst
python/trunk/Doc/distutils/uploading.rst
python/trunk/Doc/documenting/markup.rst
python/trunk/Doc/library/ast.rst
python/trunk/Doc/library/configparser.rst
python/trunk/Doc/library/ctypes.rst
python/trunk/Doc/library/decimal.rst
python/trunk/Doc/library/fractions.rst
python/trunk/Doc/library/repr.rst
python/trunk/Doc/library/socketserver.rst
python/trunk/Doc/library/tempfile.rst
Modified: python/trunk/Doc/c-api/file.rst
==============================================================================
--- python/trunk/Doc/c-api/file.rst (original)
+++ python/trunk/Doc/c-api/file.rst Sat Jan 3 21:47:01 2009
@@ -63,8 +63,8 @@
Return the file object associated with *p* as a :ctype:`FILE\*`.
If the caller will ever use the returned :ctype:`FILE\*` object while
- the GIL is released it must also call the `PyFile_IncUseCount` and
- `PyFile_DecUseCount` functions described below as appropriate.
+ the GIL is released it must also call the :cfunc:`PyFile_IncUseCount` and
+ :cfunc:`PyFile_DecUseCount` functions described below as appropriate.
.. cfunction:: void PyFile_IncUseCount(PyFileObject \*p)
@@ -72,13 +72,13 @@
Increments the PyFileObject's internal use count to indicate
that the underlying :ctype:`FILE\*` is being used.
This prevents Python from calling f_close() on it from another thread.
- Callers of this must call `PyFile_DecUseCount` when they are
+ Callers of this must call :cfunc:`PyFile_DecUseCount` when they are
finished with the :ctype:`FILE\*`. Otherwise the file object will
never be closed by Python.
The GIL must be held while calling this function.
- The suggested use is to call this after `PyFile_AsFile` just before
+ The suggested use is to call this after :cfunc:`PyFile_AsFile` just before
you release the GIL.
.. versionadded:: 2.6
@@ -88,7 +88,7 @@
Decrements the PyFileObject's internal unlocked_count member to
indicate that the caller is done with its own use of the :ctype:`FILE\*`.
- This may only be called to undo a prior call to `PyFile_IncUseCount`.
+ This may only be called to undo a prior call to :cfunc:`PyFile_IncUseCount`.
The GIL must be held while calling this function.
Modified: python/trunk/Doc/distutils/uploading.rst
==============================================================================
--- python/trunk/Doc/distutils/uploading.rst (original)
+++ python/trunk/Doc/distutils/uploading.rst Sat Jan 3 21:47:01 2009
@@ -35,9 +35,9 @@
be available for execution on the system :envvar:`PATH`. You can also specify
which key to use for signing using the :option:`--identity=*name*` option.
-Other :command:`upload` options include :option:`--repository=*url*`
-or :option:`--repository=*section*` where `url` is the url of the server
-and `section` the name of the section in :file:`$HOME/.pypirc`, and
+Other :command:`upload` options include :option:`--repository=<url>` or
+:option:`--repository=<section>` where *url* is the url of the server and
+*section* the name of the section in :file:`$HOME/.pypirc`, and
:option:`--show-response` (which displays the full response text from the PyPI
server for help in debugging upload problems).
Modified: python/trunk/Doc/documenting/markup.rst
==============================================================================
--- python/trunk/Doc/documenting/markup.rst (original)
+++ python/trunk/Doc/documenting/markup.rst Sat Jan 3 21:47:01 2009
@@ -599,7 +599,7 @@
Example::
.. versionadded:: 2.5
- The `spam` parameter.
+ The *spam* parameter.
Note that there must be no blank line between the directive head and the
explanation; this is to make these blocks visually continuous in the markup.
@@ -760,7 +760,7 @@
Blank lines are not allowed within ``productionlist`` directive arguments.
The definition can contain token names which are marked as interpreted text
- (e.g. ``sum ::= `integer` "+" `integer```) -- this generates cross-references
+ (e.g. ``unaryneg ::= "-" `integer```) -- this generates cross-references
to the productions of these tokens.
Note that no further reST parsing is done in the production, so that you
Modified: python/trunk/Doc/library/ast.rst
==============================================================================
--- python/trunk/Doc/library/ast.rst (original)
+++ python/trunk/Doc/library/ast.rst Sat Jan 3 21:47:01 2009
@@ -191,7 +191,7 @@
A node visitor base class that walks the abstract syntax tree and calls a
visitor function for every node found. This function may return a value
- which is forwarded by the `visit` method.
+ which is forwarded by the :meth:`visit` method.
This class is meant to be subclassed, with the subclass adding visitor
methods.
@@ -220,11 +220,11 @@
A :class:`NodeVisitor` subclass that walks the abstract syntax tree and
allows modification of nodes.
- The `NodeTransformer` will walk the AST and use the return value of the
- visitor methods to replace or remove the old node. If the return value of
- the visitor method is ``None``, the node will be removed from its location,
- otherwise it is replaced with the return value. The return value may be the
- original node in which case no replacement takes place.
+ The :class:`NodeTransformer` will walk the AST and use the return value of
+ the visitor methods to replace or remove the old node. If the return value
+ of the visitor method is ``None``, the node will be removed from its
+ location, otherwise it is replaced with the return value. The return value
+ may be the original node in which case no replacement takes place.
Here is an example transformer that rewrites all occurrences of name lookups
(``foo``) to ``data['foo']``::
Modified: python/trunk/Doc/library/configparser.rst
==============================================================================
--- python/trunk/Doc/library/configparser.rst (original)
+++ python/trunk/Doc/library/configparser.rst Sat Jan 3 21:47:01 2009
@@ -11,9 +11,9 @@
.. note::
- The :mod:`ConfigParser` module has been renamed to `configparser` in Python
- 3.0. The :term:`2to3` tool will automatically adapt imports when converting
- your sources to 3.0.
+ The :mod:`ConfigParser` module has been renamed to :mod:`configparser` in
+ Python 3.0. The :term:`2to3` tool will automatically adapt imports when
+ converting your sources to 3.0.
.. index::
pair: .ini; file
Modified: python/trunk/Doc/library/ctypes.rst
==============================================================================
--- python/trunk/Doc/library/ctypes.rst (original)
+++ python/trunk/Doc/library/ctypes.rst Sat Jan 3 21:47:01 2009
@@ -1378,24 +1378,22 @@
The *mode* parameter can be used to specify how the library is loaded. For
details, consult the ``dlopen(3)`` manpage, on Windows, *mode* is ignored.
-The *use_errno* parameter, when set to True, enables a ctypes
-mechanism that allows to access the system `errno` error number in a
-safe way. `ctypes` maintains a thread-local copy of the systems
-`errno` variable; if you call foreign functions created with
-`use_errno=True` then the `errno` value before the function call is
-swapped with the ctypes private copy, the same happens immediately
-after the function call.
-
-The function `ctypes.get_errno()` returns the value of the ctypes
-private copy, and the function `ctypes.set_errno(value)` changes the
-ctypes private copy to `value` and returns the former value.
-
-The *use_last_error* parameter, when set to True, enables the same
-mechanism for the Windows error code which is managed by the
-:func:`GetLastError` and :func:`SetLastError` Windows API functions;
-`ctypes.get_last_error()` and `ctypes.set_last_error(value)` are used
-to request and change the ctypes private copy of the windows error
-code.
+The *use_errno* parameter, when set to True, enables a ctypes mechanism that
+allows to access the system :data:`errno` error number in a safe way.
+:mod:`ctypes` maintains a thread-local copy of the systems :data:`errno`
+variable; if you call foreign functions created with ``use_errno=True`` then the
+:data:`errno` value before the function call is swapped with the ctypes private
+copy, the same happens immediately after the function call.
+
+The function :func:`ctypes.get_errno` returns the value of the ctypes private
+copy, and the function :func:`ctypes.set_errno` changes the ctypes private copy
+to a new value and returns the former value.
+
+The *use_last_error* parameter, when set to True, enables the same mechanism for
+the Windows error code which is managed by the :func:`GetLastError` and
+:func:`SetLastError` Windows API functions; :func:`ctypes.get_last_error` and
+:func:`ctypes.set_last_error` are used to request and change the ctypes private
+copy of the windows error code.
.. versionadded:: 2.6
The ``use_last_error`` and ``use_errno`` optional parameters
@@ -1602,22 +1600,23 @@
.. function:: CFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)
The returned function prototype creates functions that use the standard C
- calling convention. The function will release the GIL during the call.
- If `use_errno` is set to True, the ctypes private copy of the system `errno`
- variable is exchanged with the real `errno` value bafore and after the call;
- `use_last_error` does the same for the Windows error code.
+ calling convention. The function will release the GIL during the call. If
+ *use_errno* is set to True, the ctypes private copy of the system
+ :data:`errno` variable is exchanged with the real :data:`errno` value bafore
+ and after the call; *use_last_error* does the same for the Windows error
+ code.
.. versionchanged:: 2.6
- The optional `use_errno` and `use_last_error` parameters were
- added.
+ The optional *use_errno* and *use_last_error* parameters were added.
.. function:: WINFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)
Windows only: The returned function prototype creates functions that use the
- ``stdcall`` calling convention, except on Windows CE where :func:`WINFUNCTYPE`
- is the same as :func:`CFUNCTYPE`. The function will release the GIL during the
- call. `use_errno` and `use_last_error` have the same meaning as above.
+ ``stdcall`` calling convention, except on Windows CE where
+ :func:`WINFUNCTYPE` is the same as :func:`CFUNCTYPE`. The function will
+ release the GIL during the call. *use_errno* and *use_last_error* have the
+ same meaning as above.
.. function:: PYFUNCTYPE(restype, *argtypes)
@@ -1864,10 +1863,10 @@
.. function:: find_library(name)
:module: ctypes.util
- Try to find a library and return a pathname. `name` is the library name without
- any prefix like `lib`, suffix like ``.so``, ``.dylib`` or version number (this
- is the form used for the posix linker option :option:`-l`). If no library can
- be found, returns ``None``.
+ Try to find a library and return a pathname. *name* is the library name
+ without any prefix like ``lib```, suffix like ``.so``, ``.dylib`` or version
+ number (this is the form used for the posix linker option :option:`-l`). If
+ no library can be found, returns ``None``.
The exact functionality is system dependent.
@@ -1905,14 +1904,14 @@
.. function:: get_errno()
Returns the current value of the ctypes-private copy of the system
- `errno` variable in the calling thread.
+ :data:`errno` variable in the calling thread.
.. versionadded:: 2.6
.. function:: get_last_error()
Windows only: returns the current value of the ctypes-private copy of the system
- `LastError` variable in the calling thread.
+ :data:`LastError` variable in the calling thread.
.. versionadded:: 2.6
@@ -1969,17 +1968,16 @@
.. function:: set_errno(value)
- Set the current value of the ctypes-private copy of the system
- `errno` variable in the calling thread to `value` and return the
- previous value.
+ Set the current value of the ctypes-private copy of the system :data:`errno`
+ variable in the calling thread to *value* and return the previous value.
.. versionadded:: 2.6
.. function:: set_last_error(value)
- Windows only: set the current value of the ctypes-private copy of
- the system `LastError` variable in the calling thread to `value`
- and return the previous value.
+ Windows only: set the current value of the ctypes-private copy of the system
+ :data:`LastError` variable in the calling thread to *value* and return the
+ previous value.
.. versionadded:: 2.6
Modified: python/trunk/Doc/library/decimal.rst
==============================================================================
--- python/trunk/Doc/library/decimal.rst (original)
+++ python/trunk/Doc/library/decimal.rst Sat Jan 3 21:47:01 2009
@@ -1211,7 +1211,7 @@
.. method:: logical_and(x, y)
- Applies the logical operation `and` between each operand's digits.
+ Applies the logical operation *and* between each operand's digits.
.. method:: logical_invert(x)
@@ -1221,12 +1221,12 @@
.. method:: logical_or(x, y)
- Applies the logical operation `or` between each operand's digits.
+ Applies the logical operation *or* between each operand's digits.
.. method:: logical_xor(x, y)
- Applies the logical operation `xor` between each operand's digits.
+ Applies the logical operation *xor* between each operand's digits.
.. method:: max(x, y)
@@ -1337,8 +1337,8 @@
.. method:: remainder_near(x, y)
- Returns `x - y * n`, where *n* is the integer nearest the exact value
- of `x / y` (if the result is `0` then its sign will be the sign of *x*).
+ Returns ``x - y * n``, where *n* is the integer nearest the exact value
+ of ``x / y`` (if the result is 0 then its sign will be the sign of *x*).
.. method:: rotate(x, y)
Modified: python/trunk/Doc/library/fractions.rst
==============================================================================
--- python/trunk/Doc/library/fractions.rst (original)
+++ python/trunk/Doc/library/fractions.rst Sat Jan 3 21:47:01 2009
@@ -101,11 +101,11 @@
.. function:: gcd(a, b)
- Return the greatest common divisor of the integers `a` and `b`. If
- either `a` or `b` is nonzero, then the absolute value of `gcd(a,
- b)` is the largest integer that divides both `a` and `b`. `gcd(a,b)`
- has the same sign as `b` if `b` is nonzero; otherwise it takes the sign
- of `a`. `gcd(0, 0)` returns `0`.
+ Return the greatest common divisor of the integers *a* and *b*. If either
+ *a* or *b* is nonzero, then the absolute value of ``gcd(a, b)`` is the
+ largest integer that divides both *a* and *b*. ``gcd(a,b)`` has the same
+ sign as *b* if *b* is nonzero; otherwise it takes the sign of *a*. ``gcd(0,
+ 0)`` returns ``0``.
.. seealso::
Modified: python/trunk/Doc/library/repr.rst
==============================================================================
--- python/trunk/Doc/library/repr.rst (original)
+++ python/trunk/Doc/library/repr.rst Sat Jan 3 21:47:01 2009
@@ -125,15 +125,15 @@
the handling of types already supported. This example shows how special support
for file objects could be added::
- import repr
+ import repr as reprlib
import sys
- class MyRepr(repr.Repr):
+ class MyRepr(reprlib.Repr):
def repr_file(self, obj, level):
if obj.name in ['<stdin>', '<stdout>', '<stderr>']:
return obj.name
else:
- return `obj`
+ return repr(obj)
aRepr = MyRepr()
print aRepr.repr(sys.stdin) # prints '<stdin>'
Modified: python/trunk/Doc/library/socketserver.rst
==============================================================================
--- python/trunk/Doc/library/socketserver.rst (original)
+++ python/trunk/Doc/library/socketserver.rst Sat Jan 3 21:47:01 2009
@@ -7,9 +7,9 @@
.. note::
- The :mod:`SocketServer` module has been renamed to `socketserver` in Python
- 3.0. The :term:`2to3` tool will automatically adapt imports when converting
- your sources to 3.0.
+ The :mod:`SocketServer` module has been renamed to :mod:`socketserver` in
+ Python 3.0. The :term:`2to3` tool will automatically adapt imports when
+ converting your sources to 3.0.
The :mod:`SocketServer` module simplifies the task of writing network servers.
Modified: python/trunk/Doc/library/tempfile.rst
==============================================================================
--- python/trunk/Doc/library/tempfile.rst (original)
+++ python/trunk/Doc/library/tempfile.rst Sat Jan 3 21:47:01 2009
@@ -164,11 +164,11 @@
.. warning::
- Use of this function may introduce a security hole in your program.
- By the time you get around to doing anything with the file name it
- returns, someone else may have beaten you to the punch.
- :func:`mktemp` usage can be replaced easily with
- :func:`NamedTemporaryFile`, passing it the `delete=False` parameter::
+ Use of this function may introduce a security hole in your program. By
+ the time you get around to doing anything with the file name it returns,
+ someone else may have beaten you to the punch. :func:`mktemp` usage can
+ be replaced easily with :func:`NamedTemporaryFile`, passing it the
+ ``delete=False`` parameter::
>>> f = NamedTemporaryFile(delete=False)
>>> f
More information about the Python-checkins
mailing list