summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2009-01-01 00:23:30 (GMT)
committerBenjamin Peterson <benjamin@python.org>2009-01-01 00:23:30 (GMT)
commitda10d3b7a5b4c3be5b3bbf0c4cfcd18110a0decd (patch)
tree2f1b89aa725cf9aac448443fb479dafdda588319 /Doc
parentde342c4a77eaf88d1ce21d75b09f78998962fa11 (diff)
downloadcpython-da10d3b7a5b4c3be5b3bbf0c4cfcd18110a0decd.zip
cpython-da10d3b7a5b4c3be5b3bbf0c4cfcd18110a0decd.tar.gz
cpython-da10d3b7a5b4c3be5b3bbf0c4cfcd18110a0decd.tar.bz2
Merged revisions 67952,67957-67958,67960-67961,67963,67973,67978,67995,68030,68057,68061 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r67952 | georg.brandl | 2008-12-27 11:42:40 -0600 (Sat, 27 Dec 2008) | 2 lines #4752: actually use custom handler in example. ........ r67957 | georg.brandl | 2008-12-27 12:49:19 -0600 (Sat, 27 Dec 2008) | 2 lines #4754: improve winsound documentation. ........ r67958 | georg.brandl | 2008-12-27 13:02:59 -0600 (Sat, 27 Dec 2008) | 2 lines #4682: 'b' is actually unsigned char. ........ r67960 | georg.brandl | 2008-12-27 13:04:44 -0600 (Sat, 27 Dec 2008) | 2 lines #4695: fix backslashery. ........ r67961 | georg.brandl | 2008-12-27 13:06:04 -0600 (Sat, 27 Dec 2008) | 2 lines Use :samp: role. ........ r67963 | georg.brandl | 2008-12-27 13:11:15 -0600 (Sat, 27 Dec 2008) | 2 lines #4671: document that pydoc imports modules. ........ r67973 | alexandre.vassalotti | 2008-12-27 20:58:22 -0600 (Sat, 27 Dec 2008) | 2 lines Document Py_VaBuildValue. ........ r67978 | georg.brandl | 2008-12-28 05:58:49 -0600 (Sun, 28 Dec 2008) | 2 lines #4731: clarify message about missing module prerequisites. ........ r67995 | benjamin.peterson | 2008-12-28 15:16:07 -0600 (Sun, 28 Dec 2008) | 1 line #4763 PyErr_ExceptionMatches won't blow up with NULL arguments ........ r68030 | benjamin.peterson | 2008-12-29 15:38:14 -0600 (Mon, 29 Dec 2008) | 1 line fix French ........ r68057 | vinay.sajip | 2008-12-30 01:01:25 -0600 (Tue, 30 Dec 2008) | 1 line Minor documentation change relating to NullHandler. ........ r68061 | georg.brandl | 2008-12-30 04:15:49 -0600 (Tue, 30 Dec 2008) | 2 lines #4778: attributes can't be called. ........
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/arg.rst10
-rw-r--r--Doc/c-api/exceptions.rst9
-rw-r--r--Doc/howto/unicode.rst2
-rw-r--r--Doc/library/multiprocessing.rst6
-rw-r--r--Doc/library/pydoc.rst7
-rw-r--r--Doc/library/winsound.rst9
6 files changed, 30 insertions, 13 deletions
diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst
index 0c4be63..1b2ab8f 100644
--- a/Doc/c-api/arg.rst
+++ b/Doc/c-api/arg.rst
@@ -164,8 +164,9 @@ variable(s) whose address should be passed.
them. Instead, the implementation assumes that the string object uses the
encoding passed in as parameter.
-``b`` (integer) [char]
- Convert a Python integer to a tiny int, stored in a C :ctype:`char`.
+``b`` (integer) [unsigned char]
+ Convert a nonnegative Python integer to an unsigned tiny int, stored in a C
+ :ctype:`unsigned char`.
``B`` (integer) [unsigned char]
Convert a Python integer to a tiny int without overflow checking, stored in a C
@@ -552,3 +553,8 @@ and the following format units are left untouched.
If there is an error in the format string, the :exc:`SystemError` exception is
set and *NULL* returned.
+
+.. cfunction:: PyObject* Py_VaBuildValue(const char *format, va_list vargs)
+
+ Identical to :cfunc:`Py_BuildValue`, except that it accepts a va_list
+ rather than a variable number of arguments.
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index 7440dda..3fb6e56 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -67,11 +67,10 @@ in various ways. There is a separate error indicator for each thread.
.. cfunction:: int PyErr_GivenExceptionMatches(PyObject *given, PyObject *exc)
- Return true if the *given* exception matches the exception in *exc*. If *exc*
- is a class object, this also returns true when *given* is an instance of a
- subclass. If *exc* is a tuple, all exceptions in the tuple (and recursively in
- subtuples) are searched for a match. If *given* is *NULL*, a memory access
- violation will occur.
+ Return true if the *given* exception matches the exception in *exc*. If
+ *exc* is a class object, this also returns true when *given* is an instance
+ of a subclass. If *exc* is a tuple, all exceptions in the tuple (and
+ recursively in subtuples) are searched for a match.
.. cfunction:: void PyErr_NormalizeException(PyObject**exc, PyObject**val, PyObject**tb)
diff --git a/Doc/howto/unicode.rst b/Doc/howto/unicode.rst
index a01d723..8200723 100644
--- a/Doc/howto/unicode.rst
+++ b/Doc/howto/unicode.rst
@@ -32,7 +32,7 @@ For a while people just wrote programs that didn't display accents. I remember
looking at Apple ][ BASIC programs, published in French-language publications in
the mid-1980s, that had lines like these::
- PRINT "FICHER EST COMPLETE."
+ PRINT "FICHIER EST COMPLETE."
PRINT "CARACTERE NON ACCEPTE."
Those messages should contain accents, and they just look wrong to someone who
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index dbaa64e..c2581c6 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -356,7 +356,7 @@ The :mod:`multiprocessing` package mostly replicates the API of the
.. attribute:: daemon
- The process's daemon flag, a Boolean value. This must be called before
+ The process's daemon flag, a Boolean value. This must be set before
:meth:`start` is called.
The initial value is inherited from the creating process.
@@ -1808,9 +1808,9 @@ Address Formats
filesystem.
* An ``'AF_PIPE'`` address is a string of the form
- ``r'\\\\.\\pipe\\PipeName'``. To use :func:`Client` to connect to a named
+ :samp:`r'\\\\.\\pipe\\{PipeName}'`. To use :func:`Client` to connect to a named
pipe on a remote computer called ServerName* one should use an address of the
- form ``r'\\\\ServerName\\pipe\\PipeName'`` instead.
+ form :samp:`r'\\\\{ServerName}\\pipe\\{PipeName}'`` instead.
Note that any string beginning with two backslashes is assumed by default to be
an ``'AF_PIPE'`` address rather than an ``'AF_UNIX'`` address.
diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst
index 41ea1c6..1701662 100644
--- a/Doc/library/pydoc.rst
+++ b/Doc/library/pydoc.rst
@@ -34,6 +34,13 @@ it contains the path separator for your operating system, such as a slash in
Unix), and refers to an existing Python source file, then documentation is
produced for that file.
+.. note::
+
+ In order to find objects and their documentation, :mod:`pydoc` imports the
+ module(s) to be documented. Therefore, any code on module level will be
+ executed on that occasion. Use an ``if __name__ == '__main__':`` guard to
+ only execute code when a file is invoked as a script and not just imported.
+
Specifying a :option:`-w` flag before the argument will cause HTML documentation
to be written out to a file in the current directory, instead of displaying text
on the console.
diff --git a/Doc/library/winsound.rst b/Doc/library/winsound.rst
index dfe3c84..f42ff18 100644
--- a/Doc/library/winsound.rst
+++ b/Doc/library/winsound.rst
@@ -26,8 +26,9 @@ provided by Windows platforms. It includes functions and several constants.
Call the underlying :cfunc:`PlaySound` function from the Platform API. The
*sound* parameter may be a filename, audio data as a string, or ``None``. Its
interpretation depends on the value of *flags*, which can be a bitwise ORed
- combination of the constants described below. If the system indicates an error,
- :exc:`RuntimeError` is raised.
+ combination of the constants described below. If the *sound* parameter is
+ ``None``, any currently playing waveform sound is stopped. If the system
+ indicates an error, :exc:`RuntimeError` is raised.
.. function:: MessageBeep([type=MB_OK])
@@ -102,6 +103,10 @@ provided by Windows platforms. It includes functions and several constants.
Stop playing all instances of the specified sound.
+ .. note::
+
+ This flag is not supported on modern Windows platforms.
+
.. data:: SND_ASYNC