diff options
author | Georg Brandl <georg@python.org> | 2012-05-30 20:03:20 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2012-05-30 20:03:20 (GMT) |
commit | 3539afd5c90045b86a7cb5190fbff53051e5a1b4 (patch) | |
tree | 3b1f6344a457412ca100185dce36b27d86d5802a /Doc | |
parent | a0cf90e3b1bebde4dea8b99083830b9fb209a1c0 (diff) | |
download | cpython-3539afd5c90045b86a7cb5190fbff53051e5a1b4.zip cpython-3539afd5c90045b86a7cb5190fbff53051e5a1b4.tar.gz cpython-3539afd5c90045b86a7cb5190fbff53051e5a1b4.tar.bz2 |
Update pydoc topics and fix new suspicious markup.
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/faq/library.rst | 2 | ||||
-rw-r--r-- | Doc/library/email.generator.rst | 2 | ||||
-rw-r--r-- | Doc/library/venv.rst | 4 | ||||
-rw-r--r-- | Doc/tools/sphinxext/susp-ignored.csv | 34 | ||||
-rw-r--r-- | Doc/whatsnew/3.3.rst | 2 |
5 files changed, 38 insertions, 6 deletions
diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst index 7385c59..cab2d7b 100644 --- a/Doc/faq/library.rst +++ b/Doc/faq/library.rst @@ -351,7 +351,7 @@ When run, this will produce the following output: Worker <Thread(worker 1, started 130283832797456)> running with argument 5 ... -Consult the module's documentation for more details; the :class:`~queue.Queue`` +Consult the module's documentation for more details; the :class:`~queue.Queue` class provides a featureful interface. diff --git a/Doc/library/email.generator.rst b/Doc/library/email.generator.rst index b8e4e91..c172acb 100644 --- a/Doc/library/email.generator.rst +++ b/Doc/library/email.generator.rst @@ -55,7 +55,7 @@ Here are the public methods of the :class:`Generator` class, imported from the The *policy* keyword specifies a :mod:`~email.policy` object that controls a number of aspects of the generator's operation. If no *policy* is specified, - then the *policy* attached to the message object passed to :attr:``flatten`` + then the *policy* attached to the message object passed to :attr:`flatten` is used. .. versionchanged:: 3.3 Added the *policy* keyword. diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst index 7f81281..035e8d6 100644 --- a/Doc/library/venv.rst +++ b/Doc/library/venv.rst @@ -136,9 +136,7 @@ hooks available for subclass customization:: def create(self, env_dir): """ Create a virtualized Python environment in a directory. - - :param env_dir: The target directory to create an environment in. - + env_dir is the target directory to create an environment in. """ env_dir = os.path.abspath(env_dir) context = self.create_directories(env_dir) diff --git a/Doc/tools/sphinxext/susp-ignored.csv b/Doc/tools/sphinxext/susp-ignored.csv index 555ec03..e813f93 100644 --- a/Doc/tools/sphinxext/susp-ignored.csv +++ b/Doc/tools/sphinxext/susp-ignored.csv @@ -30,6 +30,40 @@ howto/curses,,:magenta,"They are: 0:black, 1:red, 2:green, 3:yellow, 4:blue, 5:m howto/curses,,:red,"They are: 0:black, 1:red, 2:green, 3:yellow, 4:blue, 5:magenta, 6:cyan, and" howto/curses,,:white,"7:white." howto/curses,,:yellow,"They are: 0:black, 1:red, 2:green, 3:yellow, 4:blue, 5:magenta, 6:cyan, and" +howto/ipaddress,,:DB8,>>> ipaddress.ip_address('2001:DB8::1') +howto/ipaddress,,::,>>> ipaddress.ip_address('2001:DB8::1') +howto/ipaddress,,:db8,IPv6Address('2001:db8::1') +howto/ipaddress,,::,IPv6Address('2001:db8::1') +howto/ipaddress,,:db8,IPv6Address('2001:db8::1') +howto/ipaddress,,::,IPv6Address('2001:db8::1') +howto/ipaddress,,::,IPv6Address('::1') +howto/ipaddress,,:db8,>>> ipaddress.ip_network('2001:db8::0/96') +howto/ipaddress,,::,>>> ipaddress.ip_network('2001:db8::0/96') +howto/ipaddress,,:db8,IPv6Network('2001:db8::/96') +howto/ipaddress,,::,IPv6Network('2001:db8::/96') +howto/ipaddress,,:db8,IPv6Network('2001:db8::/128') +howto/ipaddress,,::,IPv6Network('2001:db8::/128') +howto/ipaddress,,:db8,>>> ipaddress.ip_network('2001:db8::1/96') +howto/ipaddress,,::,>>> ipaddress.ip_network('2001:db8::1/96') +howto/ipaddress,,:db8,IPv6Interface('2001:db8::1/96') +howto/ipaddress,,::,IPv6Interface('2001:db8::1/96') +howto/ipaddress,,:db8,>>> addr6 = ipaddress.ip_address('2001:db8::1') +howto/ipaddress,,::,>>> addr6 = ipaddress.ip_address('2001:db8::1') +howto/ipaddress,,:db8,>>> host6 = ipaddress.ip_interface('2001:db8::1/96') +howto/ipaddress,,::,>>> host6 = ipaddress.ip_interface('2001:db8::1/96') +howto/ipaddress,,:db8,IPv6Network('2001:db8::/96') +howto/ipaddress,,::,IPv6Network('2001:db8::/96') +howto/ipaddress,,:db8,>>> net6 = ipaddress.ip_network('2001:db8::0/96') +howto/ipaddress,,::,>>> net6 = ipaddress.ip_network('2001:db8::0/96') +howto/ipaddress,,:db8,>>> net6 = ipaddress.ip_network('2001:db8::0/96') +howto/ipaddress,,::,>>> net6 = ipaddress.ip_network('2001:db8::0/96') +howto/ipaddress,,:ffff,IPv6Address('ffff:ffff:ffff:ffff:ffff:ffff::') +howto/ipaddress,,::,IPv6Address('ffff:ffff:ffff:ffff:ffff:ffff::') +howto/ipaddress,,::,IPv6Address('::ffff:ffff') +howto/ipaddress,,:ffff,IPv6Address('::ffff:ffff') +howto/ipaddress,,::,IPv6Address('2001::1') +howto/ipaddress,,::,IPv6Address('2001::ffff:ffff') +howto/ipaddress,,:ffff,IPv6Address('2001::ffff:ffff') howto/logging,,:And,"WARNING:And this, too" howto/logging,,:And,"WARNING:root:And this, too" howto/logging,,:Doing,INFO:root:Doing something diff --git a/Doc/whatsnew/3.3.rst b/Doc/whatsnew/3.3.rst index fe13422..cd57a39 100644 --- a/Doc/whatsnew/3.3.rst +++ b/Doc/whatsnew/3.3.rst @@ -600,7 +600,7 @@ any of the above controls as keyword arguments. Any control not specified in the call retains its default value. Thus you can create a policy that uses ``\r\n`` linesep characters like this:: - mypolicy = compat32.clone(linesep=`\r\n`) + mypolicy = compat32.clone(linesep='\r\n') Policies can be used to make the generation of messages in the format needed by your application simpler. Instead of having to remember to specify |