diff options
| -rw-r--r-- | Doc/library/2to3.rst | 5 | ||||
| -rw-r--r-- | Doc/library/aifc.rst | 4 | ||||
| -rw-r--r-- | Doc/library/audioop.rst | 2 | ||||
| -rw-r--r-- | Doc/library/cgi.rst | 8 | ||||
| -rw-r--r-- | Doc/library/csv.rst | 2 | ||||
| -rw-r--r-- | Doc/library/curses.rst | 2 | ||||
| -rw-r--r-- | Doc/library/dbm.rst | 2 | ||||
| -rw-r--r-- | Doc/library/decimal.rst | 4 | ||||
| -rw-r--r-- | Doc/library/io.rst | 10 | ||||
| -rw-r--r-- | Doc/library/locale.rst | 6 | ||||
| -rw-r--r-- | Doc/library/logging.rst | 2 | ||||
| -rw-r--r-- | Doc/library/multiprocessing.rst | 4 | ||||
| -rw-r--r-- | Doc/library/optparse.rst | 38 | ||||
| -rw-r--r-- | Doc/library/os.rst | 16 | ||||
| -rw-r--r-- | Doc/library/ossaudiodev.rst | 2 | ||||
| -rw-r--r-- | Doc/library/pyclbr.rst | 4 | ||||
| -rw-r--r-- | Doc/library/reprlib.rst | 15 | ||||
| -rw-r--r-- | Doc/library/shelve.rst | 4 | ||||
| -rw-r--r-- | Doc/library/sunau.rst | 10 | ||||
| -rw-r--r-- | Doc/library/tempfile.rst | 4 | ||||
| -rw-r--r-- | Doc/library/threading.rst | 9 | ||||
| -rw-r--r-- | Doc/library/tkinter.rst | 4 | ||||
| -rw-r--r-- | Doc/library/wave.rst | 6 | ||||
| -rw-r--r-- | Doc/library/webbrowser.rst | 2 |
24 files changed, 84 insertions, 81 deletions
diff --git a/Doc/library/2to3.rst b/Doc/library/2to3.rst index 43ee2a4..29ab066 100644 --- a/Doc/library/2to3.rst +++ b/Doc/library/2to3.rst @@ -246,8 +246,9 @@ and off individually. They are described here in more detail. .. 2to3fixer:: next - Converts the use of iterator's :meth:`next` methods to the :func:`next` - function. It also renames :meth:`next` methods to :meth:`~object.__next__`. + Converts the use of iterator's :meth:`~iterator.next` methods to the + :func:`next` function. It also renames :meth:`next` methods to + :meth:`~object.__next__`. .. 2to3fixer:: nonzero diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst index 59837ce..bdd3517 100644 --- a/Doc/library/aifc.rst +++ b/Doc/library/aifc.rst @@ -48,7 +48,7 @@ Module :mod:`aifc` defines the following function: time how many samples you are going to write in total and use :meth:`writeframesraw` and :meth:`setnframes`. -Objects returned by :func:`open` when a file is opened for reading have the +Objects returned by :func:`.open` when a file is opened for reading have the following methods: @@ -133,7 +133,7 @@ following methods: Close the AIFF file. After calling this method, the object can no longer be used. -Objects returned by :func:`open` when a file is opened for writing have all the +Objects returned by :func:`.open` when a file is opened for writing have all the above methods, except for :meth:`readframes` and :meth:`setpos`. In addition the following methods exist. The :meth:`get\*` methods can only be called after the corresponding :meth:`set\*` methods have been called. Before the first diff --git a/Doc/library/audioop.rst b/Doc/library/audioop.rst index 4af8536..d50a970 100644 --- a/Doc/library/audioop.rst +++ b/Doc/library/audioop.rst @@ -222,7 +222,7 @@ The module defines the following variables and functions: u-LAW encoding always uses 8 bits samples, so *width* refers only to the sample width of the output fragment here. -Note that operations such as :func:`mul` or :func:`max` make no distinction +Note that operations such as :func:`.mul` or :func:`.max` make no distinction between mono and stereo fragments, i.e. all samples are treated equal. If this is a problem the stereo fragment should be split into two mono fragments first and recombined later. Here is an example of how to do that:: diff --git a/Doc/library/cgi.rst b/Doc/library/cgi.rst index 48932d5..03dfe2d 100644 --- a/Doc/library/cgi.rst +++ b/Doc/library/cgi.rst @@ -133,8 +133,8 @@ commas:: If a field represents an uploaded file, accessing the value via the :attr:`value` attribute or the :func:`getvalue` method reads the entire file in memory as a string. This may not be what you want. You can test for an uploaded -file by testing either the :attr:`filename` attribute or the :attr:`file` -attribute. You can then read the data at leisure from the :attr:`file` +file by testing either the :attr:`filename` attribute or the :attr:`!file` +attribute. You can then read the data at leisure from the :attr:`!file` attribute:: fileitem = form["userfile"] @@ -154,7 +154,7 @@ field will be set to the value -1. The file upload draft standard entertains the possibility of uploading multiple files from one field (using a recursive :mimetype:`multipart/\*` encoding). When this occurs, the item will be a dictionary-like :class:`FieldStorage` item. -This can be determined by testing its :attr:`type` attribute, which should be +This can be determined by testing its :attr:`!type` attribute, which should be :mimetype:`multipart/form-data` (or perhaps another MIME type matching :mimetype:`multipart/\*`). In this case, it can be iterated over recursively just like the top-level form object. @@ -162,7 +162,7 @@ just like the top-level form object. When a form is submitted in the "old" format (as the query string or as a single data part of type :mimetype:`application/x-www-form-urlencoded`), the items will actually be instances of the class :class:`MiniFieldStorage`. In this case, the -:attr:`list`, :attr:`file`, and :attr:`filename` attributes are always ``None``. +:attr:`!list`, :attr:`!file`, and :attr:`filename` attributes are always ``None``. A form submitted via POST that also has a query string will contain both :class:`FieldStorage` and :class:`MiniFieldStorage` items. diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst index 6bcee11..7a997b0 100644 --- a/Doc/library/csv.rst +++ b/Doc/library/csv.rst @@ -50,7 +50,7 @@ The :mod:`csv` module defines the following functions: Return a reader object which will iterate over lines in the given *csvfile*. *csvfile* can be any object which supports the :term:`iterator` protocol and returns a - string each time its :meth:`next` method is called --- file objects and list + string each time its :meth:`!next` method is called --- file objects and list objects are both suitable. If *csvfile* is a file object, it should be opened with ``newline=''``. [#]_ An optional *dialect* parameter can be given which is used to define a set of parameters diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst index f1da52a..4ea7afe 100644 --- a/Doc/library/curses.rst +++ b/Doc/library/curses.rst @@ -183,7 +183,7 @@ The module :mod:`curses` defines the following functions: .. function:: filter() - The :func:`filter` routine, if used, must be called before :func:`initscr` is + The :func:`.filter` routine, if used, must be called before :func:`initscr` is called. The effect is that, during those calls, LINES is set to 1; the capabilities clear, cup, cud, cud1, cuu1, cuu, vpa are disabled; and the home string is set to the value of cr. The effect is that the cursor is confined to diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst index 7c2d660..bcb2378 100644 --- a/Doc/library/dbm.rst +++ b/Doc/library/dbm.rst @@ -61,7 +61,7 @@ modified by the prevailing umask). -The object returned by :func:`open` supports most of the same functionality as +The object returned by :func:`.open` supports most of the same functionality as dictionaries; keys and their corresponding values can be stored, retrieved, and deleted, and the :keyword:`in` operator and the :meth:`keys` method are available. Key and values are always stored as bytes. This means that when diff --git a/Doc/library/decimal.rst b/Doc/library/decimal.rst index f3138a8..f3b1ae4 100644 --- a/Doc/library/decimal.rst +++ b/Doc/library/decimal.rst @@ -584,7 +584,7 @@ Decimal objects .. method:: max_mag(other[, context]) - Similar to the :meth:`max` method, but the comparison is done using the + Similar to the :meth:`.max` method, but the comparison is done using the absolute values of the operands. .. method:: min(other[, context]) @@ -596,7 +596,7 @@ Decimal objects .. method:: min_mag(other[, context]) - Similar to the :meth:`min` method, but the comparison is done using the + Similar to the :meth:`.min` method, but the comparison is done using the absolute values of the operands. .. method:: next_minus([context]) diff --git a/Doc/library/io.rst b/Doc/library/io.rst index 4c80e60..1f6f813 100644 --- a/Doc/library/io.rst +++ b/Doc/library/io.rst @@ -39,7 +39,7 @@ buffered text interface to a buffered raw stream stream for text. Argument names are not part of the specification, and only the arguments of -:func:`open` are intended to be used as keyword arguments. +:func:`.open` are intended to be used as keyword arguments. Module Interface @@ -48,7 +48,7 @@ Module Interface .. data:: DEFAULT_BUFFER_SIZE An int containing the default buffer size used by the module's buffered I/O - classes. :func:`open` uses the file's blksize (as obtained by + classes. :func:`.open` uses the file's blksize (as obtained by :func:`os.stat`) if possible. .. function:: open(file, mode='r', buffering=None, encoding=None, errors=None, newline=None, closefd=True) @@ -142,8 +142,8 @@ Module Interface closed. If a filename is given *closefd* has no effect and must be ``True`` (the default). - The type of file object returned by the :func:`open` function depends on the - mode. When :func:`open` is used to open a file in a text mode (``'w'``, + The type of file object returned by the :func:`.open` function depends on the + mode. When :func:`.open` is used to open a file in a text mode (``'w'``, ``'r'``, ``'wt'``, ``'rt'``, etc.), it returns a subclass of :class:`TextIOBase` (specifically :class:`TextIOWrapper`). When used to open a file in a binary mode with buffering, the returned class is a subclass of @@ -256,7 +256,7 @@ I/O Base Classes most *limit* bytes will be read. The line terminator is always ``b'\n'`` for binary files; for text files, - the *newlines* argument to :func:`open` can be used to select the line + the *newlines* argument to :func:`.open` can be used to select the line terminator(s) recognized. .. method:: readlines(hint=-1) diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst index 9e2cab6..b536515 100644 --- a/Doc/library/locale.rst +++ b/Doc/library/locale.rst @@ -432,8 +432,8 @@ The :mod:`locale` module defines the following exception and functions: .. data:: LC_NUMERIC - Locale category for formatting numbers. The functions :func:`format`, - :func:`atoi`, :func:`atof` and :func:`str` of the :mod:`locale` module are + Locale category for formatting numbers. The functions :func:`.format`, + :func:`atoi`, :func:`atof` and :func:`.str` of the :mod:`locale` module are affected by that category. All other numeric formatting operations are not affected. @@ -491,7 +491,7 @@ document that your module is not compatible with non-\ ``C`` locale settings. The only way to perform numeric operations according to the locale is to use the special functions defined by this module: :func:`atof`, :func:`atoi`, -:func:`format`, :func:`str`. +:func:`.format`, :func:`.str`. There is no way to perform case conversions and character classifications according to the locale. For (Unicode) text strings these are done according diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index 82dab09..c78aeb8 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -998,7 +998,7 @@ instantiated directly, but always through the module-level function Handles a record by passing it to all handlers associated with this logger and its ancestors (until a false value of *propagate* is found). This method is used for unpickled records received from a socket, as well as those created locally. - Logger-level filtering is applied using :meth:`filter`. + Logger-level filtering is applied using :meth:`~Logger.filter`. .. method:: Logger.makeRecord(name, lvl, fn, lno, msg, args, exc_info, func=None, extra=None) diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 006fd5e..5cd70d9 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -1578,7 +1578,7 @@ with the :class:`Pool` class. .. method:: map_async(func, iterable[, chunksize[, callback]]) - A variant of the :meth:`map` method which returns a result object. + A variant of the :meth:`.map` method which returns a result object. If *callback* is specified then it should be a callable which accepts a single argument. When the result becomes ready *callback* is applied to @@ -1594,7 +1594,7 @@ with the :class:`Pool` class. make make the job complete **much** faster than using the default value of ``1``. - Also if *chunksize* is ``1`` then the :meth:`next` method of the iterator + Also if *chunksize* is ``1`` then the :meth:`!next` method of the iterator returned by the :meth:`imap` method has an optional *timeout* parameter: ``next(timeout)`` will raise :exc:`multiprocessing.TimeoutError` if the result cannot be returned within *timeout* seconds. diff --git a/Doc/library/optparse.rst b/Doc/library/optparse.rst index 0369aeb..6320fa7 100644 --- a/Doc/library/optparse.rst +++ b/Doc/library/optparse.rst @@ -282,7 +282,7 @@ that's rarely necessary: by default it uses ``sys.argv[1:]``.) * ``args``, the list of positional arguments leftover after parsing options This tutorial section only covers the four most important option attributes: -:attr:`action`, :attr:`type`, :attr:`dest` (destination), and :attr:`help`. Of +:attr:`action`, :attr:`!type`, :attr:`dest` (destination), and :attr:`help`. Of these, :attr:`action` is the most fundamental. @@ -829,7 +829,7 @@ this option on the command-line. The standard option actions hard-coded into print a usage message including all options and the documentation for them (If you don't supply an action, the default is ``store``. For this action, you -may also supply :attr:`type` and :attr:`dest` option attributes; see below.) +may also supply :attr:`!type` and :attr:`dest` option attributes; see below.) As you can see, most actions involve storing or updating a value somewhere. :mod:`optparse` always creates a special object for this, conventionally called @@ -860,7 +860,7 @@ then :mod:`optparse`, on seeing this option, will do the equivalent of :: options.filename = "foo" -The :attr:`type` and :attr:`dest` option attributes are almost as important as +The :attr:`!type` and :attr:`dest` option attributes are almost as important as :attr:`action`, but :attr:`action` is the only one that makes sense for *all* options. @@ -875,18 +875,18 @@ Most actions have several relevant option attributes which you may specify to guide :mod:`optparse`'s behaviour; a few have required attributes, which you must specify for any option using that action. -* ``store`` [relevant: :attr:`type`, :attr:`dest`, ``nargs``, ``choices``] +* ``store`` [relevant: :attr:`!type`, :attr:`dest`, ``nargs``, ``choices``] The option must be followed by an argument, which is converted to a value - according to :attr:`type` and stored in :attr:`dest`. If ``nargs`` > 1, + according to :attr:`!type` and stored in :attr:`dest`. If ``nargs`` > 1, multiple arguments will be consumed from the command line; all will be converted - according to :attr:`type` and stored to :attr:`dest` as a tuple. See the + according to :attr:`!type` and stored to :attr:`dest` as a tuple. See the "Option types" section below. If ``choices`` is supplied (a list or tuple of strings), the type defaults to ``choice``. - If :attr:`type` is not supplied, it defaults to ``string``. + If :attr:`!type` is not supplied, it defaults to ``string``. If :attr:`dest` is not supplied, :mod:`optparse` derives a destination from the first long option string (e.g., ``"--foo-bar"`` implies ``foo_bar``). If there @@ -938,7 +938,7 @@ must specify for any option using that action. parser.add_option("--clobber", action="store_true", dest="clobber") parser.add_option("--no-clobber", action="store_false", dest="clobber") -* ``append`` [relevant: :attr:`type`, :attr:`dest`, ``nargs``, ``choices``] +* ``append`` [relevant: :attr:`!type`, :attr:`dest`, ``nargs``, ``choices``] The option must be followed by an argument, which is appended to the list in :attr:`dest`. If no default value for :attr:`dest` is supplied, an empty list @@ -946,7 +946,7 @@ must specify for any option using that action. the command-line. If ``nargs`` > 1, multiple arguments are consumed, and a tuple of length ``nargs`` is appended to :attr:`dest`. - The defaults for :attr:`type` and :attr:`dest` are the same as for the ``store`` + The defaults for :attr:`!type` and :attr:`dest` are the same as for the ``store`` action. Example:: @@ -988,7 +988,7 @@ must specify for any option using that action. options.verbosity += 1 -* ``callback`` [required: ``callback``; relevant: :attr:`type`, ``nargs``, +* ``callback`` [required: ``callback``; relevant: :attr:`!type`, ``nargs``, ``callback_args``, ``callback_kwargs``] Call the function specified by ``callback``, which is called as :: @@ -1061,7 +1061,7 @@ to a particular option, or fail to pass a required option attribute, Determines :mod:`optparse`'s behaviour when this option is seen on the command line; the available options are documented above. -* :attr:`type` (default: ``"string"``) +* :attr:`!type` (default: ``"string"``) The argument type expected by this option (e.g., ``"string"`` or ``"int"``); the available option types are documented below. @@ -1079,7 +1079,7 @@ to a particular option, or fail to pass a required option attribute, * ``nargs`` (default: 1) - How many arguments of type :attr:`type` should be consumed when this option is + How many arguments of type :attr:`!type` should be consumed when this option is seen. If > 1, :mod:`optparse` will store a tuple of values to :attr:`dest`. * ``const`` @@ -1410,15 +1410,15 @@ The four arguments to a callback are described below. There are several other option attributes that you can supply when you define a callback option: -:attr:`type` +:attr:`!type` has its usual meaning: as with the ``store`` or ``append`` actions, it instructs - :mod:`optparse` to consume one argument and convert it to :attr:`type`. Rather + :mod:`optparse` to consume one argument and convert it to :attr:`!type`. Rather than storing the converted value(s) anywhere, though, :mod:`optparse` passes it to your callback function. ``nargs`` also has its usual meaning: if it is supplied and > 1, :mod:`optparse` will - consume ``nargs`` arguments, each of which must be convertible to :attr:`type`. + consume ``nargs`` arguments, each of which must be convertible to :attr:`!type`. It then passes a tuple of converted values to your callback. ``callback_args`` @@ -1450,8 +1450,8 @@ where ``value`` is the argument to this option seen on the command-line. :mod:`optparse` will - only expect an argument if :attr:`type` is set; the type of ``value`` will be - the type implied by the option's type. If :attr:`type` for this option is + only expect an argument if :attr:`!type` is set; the type of ``value`` will be + the type implied by the option's type. If :attr:`!type` for this option is ``None`` (no argument expected), then ``value`` will be ``None``. If ``nargs`` > 1, ``value`` will be a tuple of values of the appropriate type. @@ -1578,7 +1578,7 @@ Callback example 5: fixed arguments Things get slightly more interesting when you define callback options that take a fixed number of arguments. Specifying that a callback option takes arguments is similar to defining a ``store`` or ``append`` option: if you define -:attr:`type`, then the option takes one argument that must be convertible to +:attr:`!type`, then the option takes one argument that must be convertible to that type; if you further define ``nargs``, then the option takes ``nargs`` arguments. @@ -1757,7 +1757,7 @@ Adding new actions is a bit trickier, because you have to understand that "typed" actions actions that take a value from the command line and expect it to be of a certain type; or rather, a string that can be converted to a certain type. These - options require a :attr:`type` attribute to the Option constructor. + options require a :attr:`!type` attribute to the Option constructor. These are overlapping sets: some default "store" actions are ``store``, ``store_const``, ``append``, and ``count``, while the default "typed" actions diff --git a/Doc/library/os.rst b/Doc/library/os.rst index 218437e..db96a56 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -516,10 +516,10 @@ by file descriptors. .. note:: - This function is intended for low-level I/O. For normal usage, use the built-in - function :func:`open`, which returns a "file object" with :meth:`~file.read` and - :meth:`~file.write` methods (and many more). To wrap a file descriptor in a "file - object", use :func:`fdopen`. + This function is intended for low-level I/O. For normal usage, use the + built-in function :func:`open`, which returns a "file object" with + :meth:`~file.read` and :meth:`~file.write` methods (and many more). To + wrap a file descriptor in a "file object", use :func:`fdopen`. .. function:: openpty() @@ -662,10 +662,10 @@ Files and Directories .. note:: - Using :func:`access` to check if a user is authorized to e.g. open a file before - actually doing so using :func:`open` creates a security hole, because the user - might exploit the short time interval between checking and opening the file to - manipulate it. + Using :func:`access` to check if a user is authorized to e.g. open a file + before actually doing so using :func:`open` creates a security hole, + because the user might exploit the short time interval between checking + and opening the file to manipulate it. .. note:: diff --git a/Doc/library/ossaudiodev.rst b/Doc/library/ossaudiodev.rst index 3ed3fb8..3972f14 100644 --- a/Doc/library/ossaudiodev.rst +++ b/Doc/library/ossaudiodev.rst @@ -118,7 +118,7 @@ Alternately, you can use the :meth:`setparameters` method to set all three audio parameters at once. This is more convenient, but may not be as flexible in all cases. -The audio device objects returned by :func:`open` define the following methods +The audio device objects returned by :func:`.open` define the following methods and (read-only) attributes: diff --git a/Doc/library/pyclbr.rst b/Doc/library/pyclbr.rst index a5d8494..36b46f4 100644 --- a/Doc/library/pyclbr.rst +++ b/Doc/library/pyclbr.rst @@ -78,7 +78,7 @@ members: .. attribute:: Class.lineno The line number of the ``class`` statement within the file named by - :attr:`file`. + :attr:`~Class.file`. .. _pyclbr-function-objects: @@ -109,5 +109,5 @@ The :class:`Function` objects used as values in the dictionary returned by .. attribute:: Function.lineno The line number of the ``def`` statement within the file named by - :attr:`file`. + :attr:`~Function.file`. diff --git a/Doc/library/reprlib.rst b/Doc/library/reprlib.rst index 0da29fc..17a6ac4 100644 --- a/Doc/library/reprlib.rst +++ b/Doc/library/reprlib.rst @@ -23,16 +23,17 @@ This module provides a class, an instance, and a function: .. data:: aRepr - This is an instance of :class:`Repr` which is used to provide the :func:`repr` - function described below. Changing the attributes of this object will affect - the size limits used by :func:`repr` and the Python debugger. + This is an instance of :class:`Repr` which is used to provide the + :func:`.repr` function described below. Changing the attributes of this + object will affect the size limits used by :func:`.repr` and the Python + debugger. .. function:: repr(obj) - This is the :meth:`repr` method of ``aRepr``. It returns a string similar to - that returned by the built-in function of the same name, but with limits on - most sizes. + This is the :meth:`~Repr.repr` method of ``aRepr``. It returns a string + similar to that returned by the built-in function of the same name, but with + limits on most sizes. .. _repr-objects: @@ -92,7 +93,7 @@ which format specific object types. .. method:: Repr.repr1(obj, level) - Recursive implementation used by :meth:`repr`. This uses the type of *obj* to + Recursive implementation used by :meth:`.repr`. This uses the type of *obj* to determine which formatting method to call, passing it *obj* and *level*. The type-specific methods should call :meth:`repr1` to perform recursive formatting, with ``level - 1`` for the value of *level* in the recursive call. diff --git a/Doc/library/shelve.rst b/Doc/library/shelve.rst index 62005a4..35ed84c 100644 --- a/Doc/library/shelve.rst +++ b/Doc/library/shelve.rst @@ -101,7 +101,7 @@ Restrictions .. class:: BsdDbShelf(dict[, protocol=None[, writeback=False]]) - A subclass of :class:`Shelf` which exposes :meth:`first`, :meth:`next`, + A subclass of :class:`Shelf` which exposes :meth:`first`, :meth:`!next`, :meth:`previous`, :meth:`last` and :meth:`set_location` which are available in the third-party :mod:`bsddb` module from `pybsddb <http://www.jcea.es/programacion/pybsddb.htm>`_ but not in other database @@ -117,7 +117,7 @@ Restrictions A subclass of :class:`Shelf` which accepts a *filename* instead of a dict-like object. The underlying file will be opened using :func:`dbm.open`. By default, the file will be created and opened for both read and write. The - optional *flag* parameter has the same interpretation as for the :func:`open` + optional *flag* parameter has the same interpretation as for the :func:`.open` function. The optional *protocol* and *writeback* parameters have the same interpretation as for the :class:`Shelf` class. diff --git a/Doc/library/sunau.rst b/Doc/library/sunau.rst index 9930133..3f231b4 100644 --- a/Doc/library/sunau.rst +++ b/Doc/library/sunau.rst @@ -58,18 +58,18 @@ The :mod:`sunau` module defines the following functions: .. function:: openfp(file, mode) - A synonym for :func:`open`, maintained for backwards compatibility. + A synonym for :func:`.open`, maintained for backwards compatibility. -The :mod:`sunau` module defines the following exception: +The :mod:`sunau` module defines the following exception: .. exception:: Error An error raised when something is impossible because of Sun AU specs or implementation deficiency. -The :mod:`sunau` module defines the following data items: +The :mod:`sunau` module defines the following data items: .. data:: AUDIO_FILE_MAGIC @@ -104,7 +104,7 @@ The :mod:`sunau` module defines the following data items: AU_read Objects --------------- -AU_read objects, as returned by :func:`open` above, have the following methods: +AU_read objects, as returned by :func:`.open` above, have the following methods: .. method:: AU_read.close() @@ -197,7 +197,7 @@ and don't do anything interesting. AU_write Objects ---------------- -AU_write objects, as returned by :func:`open` above, have the following methods: +AU_write objects, as returned by :func:`.open` above, have the following methods: .. method:: AU_write.setnchannels(n) diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst index 36c8753..722c5ee 100644 --- a/Doc/library/tempfile.rst +++ b/Doc/library/tempfile.rst @@ -48,7 +48,7 @@ The module defines the following user-callable functions: The *dir*, *prefix* and *suffix* parameters are passed to :func:`mkstemp`. The returned object is a true file object on POSIX platforms. On other - platforms, it is a file-like object whose :attr:`file` attribute is the + platforms, it is a file-like object whose :attr:`!file` attribute is the underlying true file object. This file-like object can be used in a :keyword:`with` statement, just like a normal file. @@ -63,7 +63,7 @@ The module defines the following user-callable functions: still open, varies across platforms (it can be so used on Unix; it cannot on Windows NT or later). If *delete* is true (the default), the file is deleted as soon as it is closed. - The returned object is always a file-like object whose :attr:`file` + The returned object is always a file-like object whose :attr:`!file` attribute is the underlying true file object. This file-like object can be used in a :keyword:`with` statement, just like a normal file. diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst index ce91750..86a9bf8 100644 --- a/Doc/library/threading.rst +++ b/Doc/library/threading.rst @@ -54,8 +54,9 @@ This module defines the following functions and objects: :noindex: A factory function that returns a new event object. An event manages a flag - that can be set to true with the :meth:`set` method and reset to false with the - :meth:`clear` method. The :meth:`wait` method blocks until the flag is true. + that can be set to true with the :meth:`~Event.set` method and reset to false + with the :meth:`clear` method. The :meth:`wait` method blocks until the flag + is true. .. class:: local @@ -634,7 +635,7 @@ This is one of the simplest mechanisms for communication between threads: one thread signals an event and other threads wait for it. An event object manages an internal flag that can be set to true with the -:meth:`set` method and reset to false with the :meth:`clear` method. The +:meth:`~Event.set` method and reset to false with the :meth:`clear` method. The :meth:`wait` method blocks until the flag is true. @@ -655,7 +656,7 @@ An event object manages an internal flag that can be set to true with the .. method:: clear() Reset the internal flag to false. Subsequently, threads calling - :meth:`wait` will block until :meth:`set` is called to set the internal + :meth:`wait` will block until :meth:`.set` is called to set the internal flag to true again. .. method:: wait([timeout]) diff --git a/Doc/library/tkinter.rst b/Doc/library/tkinter.rst index 7413987..74e3fbb 100644 --- a/Doc/library/tkinter.rst +++ b/Doc/library/tkinter.rst @@ -511,7 +511,7 @@ defined in the :mod:`tkinter`. There are many useful subclasses of Variable already defined: :class:`StringVar`, :class:`IntVar`, :class:`DoubleVar`, and :class:`BooleanVar`. To read the current value of such a variable, call the -:meth:`get` method on it, and to change its value you call the :meth:`set` +:meth:`get` method on it, and to change its value you call the :meth:`!set` method. If you follow this protocol, the widget will always track the value of the variable, with no further intervention on your part. @@ -652,7 +652,7 @@ relief ``"raised"``, ``"sunken"``, ``"flat"``, ``"groove"``, and ``"ridge"``. scrollcommand - This is almost always the :meth:`set` method of some scrollbar widget, but can + This is almost always the :meth:`!set` method of some scrollbar widget, but can be any widget method that takes a single argument. Refer to the file :file:`Demo/tkinter/matt/canvas-with-scrollbars.py` in the Python source distribution for an example. diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst index b931fed..3be0343 100644 --- a/Doc/library/wave.rst +++ b/Doc/library/wave.rst @@ -33,7 +33,7 @@ The :mod:`wave` module defines the following function and exception: .. function:: openfp(file, mode) - A synonym for :func:`open`, maintained for backwards compatibility. + A synonym for :func:`.open`, maintained for backwards compatibility. .. exception:: Error @@ -47,7 +47,7 @@ The :mod:`wave` module defines the following function and exception: Wave_read Objects ----------------- -Wave_read objects, as returned by :func:`open`, have the following methods: +Wave_read objects, as returned by :func:`.open`, have the following methods: .. method:: Wave_read.close() @@ -134,7 +134,7 @@ them, and is otherwise implementation dependent. Wave_write Objects ------------------ -Wave_write objects, as returned by :func:`open`, have the following methods: +Wave_write objects, as returned by :func:`.open`, have the following methods: .. method:: Wave_write.close() diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst index 975d668..86a9043 100644 --- a/Doc/library/webbrowser.rst +++ b/Doc/library/webbrowser.rst @@ -10,7 +10,7 @@ The :mod:`webbrowser` module provides a high-level interface to allow displaying Web-based documents to users. Under most circumstances, simply calling the -:func:`open` function from this module will do the right thing. +:func:`.open` function from this module will do the right thing. Under Unix, graphical browsers are preferred under X11, but text-mode browsers will be used if graphical browsers are not available or an X11 display isn't |