From 4b05466e25b686fed9084452e88e7a8b7728a843 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Wed, 6 Oct 2010 08:56:53 +0000 Subject: Merged revisions 84945 via svnmerge from svn+ssh://svn.python.org/python/branches/py3k ........ r84945 | georg.brandl | 2010-09-21 16:48:28 +0200 (Di, 21 Sep 2010) | 1 line #9911: doc copyedits. ........ --- Doc/c-api/arg.rst | 2 +- Doc/c-api/unicode.rst | 2 +- Doc/distutils/builtdist.rst | 2 +- Doc/extending/newtypes.rst | 2 +- Doc/faq/design.rst | 2 +- Doc/faq/programming.rst | 2 +- Doc/glossary.rst | 2 +- Doc/howto/descriptor.rst | 2 +- Doc/howto/sockets.rst | 2 +- Doc/library/2to3.rst | 2 +- Doc/library/bisect.rst | 2 +- Doc/library/http.cookies.rst | 2 +- Doc/library/logging.rst | 2 +- Doc/library/multiprocessing.rst | 2 +- Doc/library/pickle.rst | 8 ++++---- Doc/library/profile.rst | 2 +- Doc/library/readline.rst | 10 ++++++++++ Doc/library/telnetlib.rst | 2 +- Doc/library/tkinter.tix.rst | 2 +- Doc/library/turtle.rst | 2 +- Doc/library/unittest.rst | 6 +++--- Doc/library/urllib.parse.rst | 2 +- Doc/library/winreg.rst | 2 +- Doc/reference/expressions.rst | 2 +- Doc/whatsnew/3.1.rst | 2 +- 25 files changed, 39 insertions(+), 29 deletions(-) diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst index 7ebd283..b5e51f6 100644 --- a/Doc/c-api/arg.rst +++ b/Doc/c-api/arg.rst @@ -65,7 +65,7 @@ Unless otherwise stated, buffers are not NUL-terminated. .. note:: This format does not accept bytes-like objects. If you want to accept filesystem paths and convert them to C character strings, it is - preferrable to use the ``O&`` format with :cfunc:`PyUnicode_FSConverter` + preferable to use the ``O&`` format with :cfunc:`PyUnicode_FSConverter` as *converter*. ``s*`` (:class:`str`, :class:`bytes`, :class:`bytearray` or buffer compatible object) [Py_buffer] diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst index 014571e..14d1c27 100644 --- a/Doc/c-api/unicode.rst +++ b/Doc/c-api/unicode.rst @@ -358,7 +358,7 @@ To encode and decode file names and other environment strings, :cdata:`Py_FileSystemEncoding` should be used as the encoding, and ``"surrogateescape"`` should be used as the error handler (:pep:`383`). To encode file names during argument parsing, the ``"O&"`` converter should be -used, passsing :func:`PyUnicode_FSConverter` as the conversion function: +used, passing :cfunc:`PyUnicode_FSConverter` as the conversion function: .. cfunction:: int PyUnicode_FSConverter(PyObject* obj, void* result) diff --git a/Doc/distutils/builtdist.rst b/Doc/distutils/builtdist.rst index 1cd5891..2a91ee3 100644 --- a/Doc/distutils/builtdist.rst +++ b/Doc/distutils/builtdist.rst @@ -357,7 +357,7 @@ would create a 64bit installation executable on your 32bit version of Windows. To cross-compile, you must download the Python source code and cross-compile Python itself for the platform you are targetting - it is not possible from a -binary installtion of Python (as the .lib etc file for other platforms are +binary installation of Python (as the .lib etc file for other platforms are not included.) In practice, this means the user of a 32 bit operating system will need to use Visual Studio 2008 to open the :file:`PCBuild/PCbuild.sln` solution in the Python source tree and build the diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst index 63ea2a6..d48efc9 100644 --- a/Doc/extending/newtypes.rst +++ b/Doc/extending/newtypes.rst @@ -1249,7 +1249,7 @@ This function is called with two Python objects and the operator as arguments, where the operator is one of ``Py_EQ``, ``Py_NE``, ``Py_LE``, ``Py_GT``, ``Py_LT`` or ``Py_GT``. It should compare the two objects with respect to the specified operator and return ``Py_True`` or ``Py_False`` if the comparison is -successfull, ``Py_NotImplemented`` to indicate that comparison is not +successful, ``Py_NotImplemented`` to indicate that comparison is not implemented and the other object's comparison method should be tried, or *NULL* if an exception was set. diff --git a/Doc/faq/design.rst b/Doc/faq/design.rst index 0753934..3889774 100644 --- a/Doc/faq/design.rst +++ b/Doc/faq/design.rst @@ -28,7 +28,7 @@ coding-style conflicts. In C there are many different ways to place the braces. If you're used to reading and writing code that uses one style, you will feel at least slightly uneasy when reading (or being required to write) another style. -Many coding styles place begin/end brackets on a line by themself. This makes +Many coding styles place begin/end brackets on a line by themselves. This makes programs considerably longer and wastes valuable screen space, making it harder to get a good overview of a program. Ideally, a function should fit on one screen (say, 20-30 lines). 20 lines of Python can do a lot more work than 20 diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst index 3c9e5f4..7226e70 100644 --- a/Doc/faq/programming.rst +++ b/Doc/faq/programming.rst @@ -952,7 +952,7 @@ Is there an equivalent to Perl's chomp() for removing trailing newlines from str ------------------------------------------------------------------------------------- Starting with Python 2.2, you can use ``S.rstrip("\r\n")`` to remove all -occurences of any line terminator from the end of the string ``S`` without +occurrences of any line terminator from the end of the string ``S`` without removing other trailing whitespace. If the string ``S`` represents more than one line, with several empty lines at the end, the line terminators for all the blank lines will be removed:: diff --git a/Doc/glossary.rst b/Doc/glossary.rst index 8dea228..a9df072 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -19,7 +19,7 @@ Glossary 2to3 A tool that tries to convert Python 2.x code to Python 3.x code by - handling most of the incompatibilites which can be detected by parsing the + handling most of the incompatibilities which can be detected by parsing the source and traversing the parse tree. 2to3 is available in the standard library as :mod:`lib2to3`; a standalone diff --git a/Doc/howto/descriptor.rst b/Doc/howto/descriptor.rst index a9ef1d8..cdb6a8e 100644 --- a/Doc/howto/descriptor.rst +++ b/Doc/howto/descriptor.rst @@ -296,7 +296,7 @@ Running the interpreter shows how the function descriptor works in practice:: > The output suggests that bound and unbound methods are two different types. -While they could have been implemented that way, the actual C implemention of +While they could have been implemented that way, the actual C implementation of :ctype:`PyMethod_Type` in `Objects/classobject.c `_ is a single object with two different representations depending on whether the diff --git a/Doc/howto/sockets.rst b/Doc/howto/sockets.rst index 9f7fe68..3927544 100644 --- a/Doc/howto/sockets.rst +++ b/Doc/howto/sockets.rst @@ -313,7 +313,7 @@ process is likely to be screwed up. Non-blocking Sockets ==================== -If you've understood the preceeding, you already know most of what you need to +If you've understood the preceding, you already know most of what you need to know about the mechanics of using sockets. You'll still use the same calls, in much the same ways. It's just that, if you do it right, your app will be almost inside-out. diff --git a/Doc/library/2to3.rst b/Doc/library/2to3.rst index f3be8fa..de31251 100644 --- a/Doc/library/2to3.rst +++ b/Doc/library/2to3.rst @@ -89,7 +89,7 @@ process. Since some print statements can be parsed as function calls or statements, 2to3 cannot always read files containing the print function. When 2to3 detects the presence of the ``from __future__ import print_function`` compiler directive, it -modifies its internal grammar to interpert :func:`print` as a function. This +modifies its internal grammar to interpret :func:`print` as a function. This change can also be enabled manually with the :option:`-p` flag. Use :option:`-p` to run fixers on code that already has had its print statements converted. diff --git a/Doc/library/bisect.rst b/Doc/library/bisect.rst index 8bf0949..eb23159 100644 --- a/Doc/library/bisect.rst +++ b/Doc/library/bisect.rst @@ -125,7 +125,7 @@ a 'B', and so on:: Unlike the :func:`sorted` function, it does not make sense for the :func:`bisect` functions to have *key* or *reversed* arguments because that would lead to an -inefficent design (successive calls to bisect functions would not "remember" +inefficient design (successive calls to bisect functions would not "remember" all of the previous key lookups). Instead, it is better to search a list of precomputed keys to find the index diff --git a/Doc/library/http.cookies.rst b/Doc/library/http.cookies.rst index 0151e94..472ddcf 100644 --- a/Doc/library/http.cookies.rst +++ b/Doc/library/http.cookies.rst @@ -125,7 +125,7 @@ Morsel Objects * ``version`` * ``httponly`` - The attribute :attr:`httponly` specifies that the cookie is only transfered + The attribute :attr:`httponly` specifies that the cookie is only transferred in HTTP requests, and is not accessible through JavaScript. This is intended to mitigate some forms of cross-site scripting. diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index 2b8e92c..c977eb8 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -2572,7 +2572,7 @@ wire). .. attribute:: exc_info Exception tuple (à la `sys.exc_info`) or `None` if no exception - information is availble. + information is available. .. attribute:: func diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 27b4c90..e23b926 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -374,7 +374,7 @@ The :mod:`multiprocessing` package mostly replicates the API of the Otherwise a daemonic process would leave its children orphaned if it gets terminated when its parent process exits. Additionally, these are **not** Unix daemons or services, they are normal processes that will be - terminated (and not joined) if non-dameonic processes have exited. + terminated (and not joined) if non-daemonic processes have exited. In addition to the :class:`Threading.Thread` API, :class:`Process` objects also support the following attributes and methods: diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst index 8157a52..3358053 100644 --- a/Doc/library/pickle.rst +++ b/Doc/library/pickle.rst @@ -197,7 +197,7 @@ process more convenient: that meets this interface. Optional keyword arguments are *fix_imports*, *encoding* and *errors*, - which are used to control compatiblity support for pickle stream generated + which are used to control compatibility support for pickle stream generated by Python 2.x. If *fix_imports* is True, pickle will try to map the old Python 2.x names to the new names used in Python 3.x. The *encoding* and *errors* tell pickle how to decode 8-bit string instances pickled by Python @@ -213,7 +213,7 @@ process more convenient: ignored. Optional keyword arguments are *fix_imports*, *encoding* and *errors*, - which are used to control compatiblity support for pickle stream generated + which are used to control compatibility support for pickle stream generated by Python 2.x. If *fix_imports* is True, pickle will try to map the old Python 2.x names to the new names used in Python 3.x. The *encoding* and *errors* tell pickle how to decode 8-bit string instances pickled by Python @@ -310,7 +310,7 @@ The :mod:`pickle` module exports two classes, :class:`Pickler` and that meets this interface. Optional keyword arguments are *fix_imports*, *encoding* and *errors*, - which are used to control compatiblity support for pickle stream generated + which are used to control compatibility support for pickle stream generated by Python 2.x. If *fix_imports* is True, pickle will try to map the old Python 2.x names to the new names used in Python 3.x. The *encoding* and *errors* tell pickle how to decode 8-bit string instances pickled by Python @@ -429,7 +429,7 @@ implementation of this behaviour:: .. index:: single: __getnewargs__() (copy protocol) -Classes can alter the default behaviour by providing one or severals special +Classes can alter the default behaviour by providing one or several special methods. In protocol 2 and newer, classes that implements the :meth:`__getnewargs__` method can dictate the values passed to the :meth:`__new__` method upon unpickling. This is often needed for classes diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst index 5888b95..e66ceaf 100644 --- a/Doc/library/profile.rst +++ b/Doc/library/profile.rst @@ -599,7 +599,7 @@ The resulting profiler will then call :func:`your_time_func`. integers, you can also invoke the class constructor with a second argument specifying the real duration of one unit of time. For example, if :func:`your_integer_time_func` returns times measured in thousands of seconds, - you would constuct the :class:`Profile` instance as follows:: + you would construct the :class:`Profile` instance as follows:: pr = profile.Profile(your_integer_time_func, 0.001) diff --git a/Doc/library/readline.rst b/Doc/library/readline.rst index abb196d..e99d317 100644 --- a/Doc/library/readline.rst +++ b/Doc/library/readline.rst @@ -15,6 +15,16 @@ made using this module affect the behaviour of both the interpreter's interactive prompt and the prompts offered by the built-in :func:`input` function. +.. note:: + + On MacOS X the :mod:`readline` module can be implemented using + the ``libedit`` library instead of GNU readline. + + The configuration file for ``libedit`` is different from that + of GNU readline. If you programmatically load configuration strings + you can check for the text "libedit" in :const:`readline.__doc__` + to differentiate between GNU readline and libedit. + The :mod:`readline` module defines the following functions: diff --git a/Doc/library/telnetlib.rst b/Doc/library/telnetlib.rst index 102a42a..6e3abde 100644 --- a/Doc/library/telnetlib.rst +++ b/Doc/library/telnetlib.rst @@ -191,7 +191,7 @@ Telnet Objects If a regular expression ends with a greedy match (such as ``.*``) or if more than one expression can match the same input, the results are - indeterministic, and may depend on the I/O timing. + non-deterministic, and may depend on the I/O timing. .. method:: Telnet.set_option_negotiation_callback(callback) diff --git a/Doc/library/tkinter.tix.rst b/Doc/library/tkinter.tix.rst index bbe66d8..68d8f5a 100644 --- a/Doc/library/tkinter.tix.rst +++ b/Doc/library/tkinter.tix.rst @@ -122,7 +122,7 @@ Basic Widgets The `ComboBox `_ widget is similar to the combo box control in MS Windows. The user can select a - choice by either typing in the entry subwdget or selecting from the listbox + choice by either typing in the entry subwidget or selecting from the listbox subwidget. .. Python Demo of: diff --git a/Doc/library/turtle.rst b/Doc/library/turtle.rst index c6ba316..711e1a1 100644 --- a/Doc/library/turtle.rst +++ b/Doc/library/turtle.rst @@ -1957,7 +1957,7 @@ Methods specific to Screen, not inherited from TurtleScreen .. function:: setup(width=_CFG["width"], height=_CFG["height"], startx=_CFG["leftright"], starty=_CFG["topbottom"]) Set the size and position of the main window. Default values of arguments - are stored in the configuration dicionary and can be changed via a + are stored in the configuration dictionary and can be changed via a :file:`turtle.cfg` file. :param width: if an integer, a size in pixels, if a float, a fraction of the diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index 560c3f9..d88b823 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -504,7 +504,7 @@ The following decorators implement test skipping and expected failures: .. function:: skipUnless(condition, reason) - Skip the decoratored test unless *condition* is true. + Skip the decorated test unless *condition* is true. .. function:: expectedFailure @@ -1241,8 +1241,8 @@ Loading and running tests .. attribute:: expectedFailures - A list contaning 2-tuples of :class:`TestCase` instances and strings - holding formatted tracebacks. Each tuple represents a expected failures + A list containing 2-tuples of :class:`TestCase` instances and strings + holding formatted tracebacks. Each tuple represents an expected failure of the test case. .. attribute:: unexpectedSuccesses diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst index 4fb2936..3e1c628 100644 --- a/Doc/library/urllib.parse.rst +++ b/Doc/library/urllib.parse.rst @@ -354,7 +354,7 @@ The :mod:`urllib.parse` module defines the following functions: :rfc:`3986` - Uniform Resource Identifiers This is the current standard (STD66). Any changes to urlparse module should conform to this. Certain deviations could be observed, which are - mostly due backward compatiblity purposes and for certain to de-facto + mostly for backward compatibility purposes and for certain de-facto parsing requirements as commonly observed in major browsers. :rfc:`2396` - Uniform Resource Identifiers (URI): Generic Syntax diff --git a/Doc/library/winreg.rst b/Doc/library/winreg.rst index bd7e8d4..68f7e91 100644 --- a/Doc/library/winreg.rst +++ b/Doc/library/winreg.rst @@ -508,7 +508,7 @@ For more information, see `Registry Key Security and Access 64-bit Specific *************** -For more information, see `Accesing an Alternate Registry View +For more information, see `Accessing an Alternate Registry View `__. .. data:: KEY_WOW64_64KEY diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst index f6a90cc..7baad6b 100644 --- a/Doc/reference/expressions.rst +++ b/Doc/reference/expressions.rst @@ -344,7 +344,7 @@ All of this makes generator functions quite similar to coroutines; they yield multiple times, they have more than one entry point and their execution can be suspended. The only difference is that a generator function cannot control where should the execution continue after it yields; the control is always -transfered to the generator's caller. +transferred to the generator's caller. The :keyword:`yield` statement is allowed in the :keyword:`try` clause of a :keyword:`try` ... :keyword:`finally` construct. If the generator is not diff --git a/Doc/whatsnew/3.1.rst b/Doc/whatsnew/3.1.rst index b4f95a7..1b6b3ce 100644 --- a/Doc/whatsnew/3.1.rst +++ b/Doc/whatsnew/3.1.rst @@ -352,7 +352,7 @@ New, Improved, and Deprecated Modules * :class:`functools.partial` objects can now be pickled. (Suggested by Antoine Pitrou and Jesse Noller. Implemented by - Jack Diedrich; :issue:`5228`.) + Jack Diederich; :issue:`5228`.) * Add :mod:`pydoc` help topics for symbols so that ``help('@')`` works as expected in the interactive environment. -- cgit v0.12