Georg Brandl
4433ff958b
unittest.mock docs: fix use of default role
2014-10-31 07:59:37 +01:00
Georg Brandl
35903c809f
Sphinx extension: move imports to the module top
2014-10-30 22:55:13 +01:00
Georg Brandl
5aa761db52
pyporting howto: fix link target
2014-10-30 22:52:02 +01:00
Georg Brandl
884217cb60
distutils example: fix invalid rst in description string
2014-10-30 22:50:46 +01:00
Georg Brandl
3b4cf554e5
rstlint: make the "html leaked markup" regex a bit less sensitive
2014-10-30 22:49:54 +01:00
Georg Brandl
ef08bde8b8
minor markup fix: no inline markup is allowed in a module synopsis
2014-10-30 22:45:27 +01:00
Georg Brandl
2273b096ce
rstlint: we do not use svn anymore
2014-10-30 22:44:41 +01:00
Georg Brandl
95988f98ea
rstlint: add more directives we use
2014-10-30 22:35:55 +01:00
Georg Brandl
eb9106c928
Doc/contents: avoid false positive in rstlint
2014-10-30 22:31:32 +01:00
Georg Brandl
f2b56518f9
rstlint: recognize "deprecated-removed" directive
2014-10-30 22:30:01 +01:00
Georg Brandl
6b4c847c4f
Doc: fix default role usage (except in unittest mock docs)
2014-10-30 22:26:26 +01:00
Georg Brandl
b7354a65ce
Fixing broken links in doc, part 4: some more breaks and redirects
2014-10-29 10:57:37 +01:00
Georg Brandl
0ef496678a
linkcheck: ignore issue URLs and PEP URLs (the latter until the PEPs are on www.python.org again).
2014-10-29 10:57:01 +01:00
Georg Brandl
525d355984
Fixing broken links in doc, part 3: the rest
2014-10-29 10:26:56 +01:00
Georg Brandl
9bdcb3bc8a
Fixing broken links in doc, part 2: howto/
2014-10-29 09:37:43 +01:00
Georg Brandl
77fe77d4af
Fixing broken links in doc, part 1: faq/
2014-10-29 09:24:54 +01:00
Georg Brandl
728e4debd8
Fix external links to docs.python.org to use internal links instead.
2014-10-29 09:00:30 +01:00
Georg Brandl
5e722f698e
Remove now-dead link to IDLE debugger doc and add PyCharm to the commercial IDEs.
2014-10-29 08:55:14 +01:00
Georg Brandl
485922ea1f
Update "where is python.org hosted" FAQ.
2014-10-29 08:52:43 +01:00
Georg Brandl
e73778c1ac
Use https:// URLs when referring to python.org hosts.
2014-10-29 08:36:35 +01:00
Georg Brandl
46761ec7c2
Use https:// URLs in the HTML templates.
2014-10-29 08:36:15 +01:00
Georg Brandl
69a7203948
Doc readme: Fix markup, use https:// URLs.
2014-10-29 08:18:43 +01:00
Georg Brandl
9ab33eada4
Adjust the author field of the .tex files to reflect that docs are now maintained by all of us
2014-10-29 08:14:04 +01:00
Georg Brandl
a1f8486325
Move HTML templates to their own subdir.
2014-10-29 08:11:46 +01:00
Georg Brandl
e03902910c
Move Sphinx extensions to their own subdir.
2014-10-29 08:07:37 +01:00
Georg Brandl
9a333a6f65
Remove a few config values that keep the default values, move values to the correct section
2014-10-29 08:04:27 +01:00
Georg Brandl
3fdea95307
Remove deprecated and now unnecessary config value from conf.py.
2014-10-29 07:58:34 +01:00
Georg Brandl
fe85807d7f
Fix link to ABOP install chapter.
2014-10-28 23:00:25 +01:00
Georg Brandl
ce64cedff4
Fix module name.
2014-10-28 22:58:24 +01:00
Georg Brandl
946faa39e3
Using "-m module" is easier to read and understand than "-mmodule".
2014-10-28 22:54:24 +01:00
Georg Brandl
4ab5733685
Update Opensolaris advice to OpenCSW instead of defunct Blastwave.
2014-10-28 22:52:49 +01:00
Georg Brandl
2b07b0e868
Closes #22249 : use IPPROTO_TCP constant instead of SOL_TCP constant for getaddrinfo() proto param
2014-10-28 22:45:27 +01:00
Georg Brandl
c943e79384
Remove duplicate bullet point.
2014-10-28 22:40:48 +01:00
Georg Brandl
bb2d669292
Closes #22736 : move seealso to the bottom of the section about RE syntax.
2014-10-28 21:41:51 +01:00
Georg Brandl
89c558da00
Closes #22748 : there are no PyString C functions in 3.x.
2014-10-28 21:38:49 +01:00
Georg Brandl
01546a88b8
Closes #22749 : remove outdated advice to use clock() for accurate timing.
2014-10-28 21:35:35 +01:00
Georg Brandl
75f7490843
PYTHONY2K is long gone. Remove traces from the docs and manpage.
2014-10-28 17:15:10 +01:00
Ezio Melotti
788f2adeae
#22196 : link to Enum in the nametuple documentation. Patch by Karmen Dykstra.
2014-10-28 15:07:14 +01:00
Ezio Melotti
9b1e92f5a1
#22237 : document that sorted() is guaranteed to be stable. Initial patch by Martin Panter.
2014-10-28 12:57:11 +01:00
Nick Coghlan
3894ae20ea
Issue #22711 : improve links in new distribution docs
...
- key term hyperlinks for distutils, setuptools & wheel
- distutils landing page links directly to setuptools docs
- short summary of setuptools benefits provided with link
2014-10-26 00:00:04 +10:00
Berker Peksag
6d1c149a46
Issue #22723 : Make link styling more accessible.
...
Patch by Buck Golemon.
2014-10-25 05:20:49 +03:00
Victor Stinner
2cef300187
asyncio doc: fix typo in an example
2014-10-23 22:38:46 +02:00
Victor Stinner
c803bd84b5
Issue #22695 : Fix syntax of open() doc
2014-10-22 09:55:44 +02:00
Antoine Pitrou
4b4ddb2190
Issue #22660 : update various mentions in the ssl module documentation.
2014-10-21 00:14:39 +02:00
Jesus Cea
67503c5f1c
Docs: 'os.pwrite()' needs bytes, not strings
2014-10-20 16:18:24 +02:00
Benjamin Peterson
0fc08fd2c7
merge 3.3
2014-10-19 10:47:58 -04:00
Ethan Furman
f87f515057
Issue7186: document that __doc__ is not inherited by subclasses
2014-10-17 22:25:22 -07:00
Victor Stinner
7f314ed71b
asyncio doc: write simpler examples to introduce asyncio
2014-10-15 18:49:16 +02:00
Ethan Furman
7184bac544
Issue20386: SocketType is again socket.socket; the IntEnum SOCK constants are SocketKind
2014-10-14 18:56:53 -07:00
Victor Stinner
39892055cd
asyncio doc: rewrite subprocess doc
...
* add a new example using transport and protocol
* rewrite the example using streams to make it much simpler (remove error
handling, use a simpler Python code)
* copy (and adapt) more documentation from the subprocess module:
- add a note about Process.wait() deadlock
- add a note about shell injection
- etc.
* sort Process methods and attributes in the same order than subprocess.Popen
methods and attributes, so the documentation looks closer
* list differences between Process and subprocess.Popen APIs
2014-10-14 00:52:07 +02:00
Victor Stinner
3c95062f52
asyncio doc: protocol_factory of subprocess_exec() and subprocess_shell() must
...
instanciate a subclass of SubprocessProtocol
2014-10-14 00:02:10 +02:00
Victor Stinner
4270a24dd9
asyncio doc: document BaseSubprocessTransport.close() method
...
Modify also the get_pipe_transport() doc to mention explicitly the supported
file descriptors.
2014-10-13 23:56:43 +02:00
Alex Gaynor
e6f8c5025a
Use https:// URLs for the bug tracker in the :issue: role.
...
Thanks to Ezio for noticing this
2014-10-13 12:58:03 -07:00
Alex Gaynor
53dfcd86e9
issue22626: Use https:// for a link to the bug tracker
2014-10-13 12:55:21 -07:00
Benjamin Peterson
157da6fdd2
merge 3.3
2014-10-13 11:55:02 -04:00
Victor Stinner
ed8e3a987e
asyncio: add missing @coroutine decorator
2014-10-13 00:55:50 +02:00
Victor Stinner
ab1c853079
asyncio doc: update debug traces
2014-10-12 21:37:16 +02:00
Victor Stinner
980dd84f92
asyncio doc: more explicit doc for async()
...
The function schedules the execution of coroutines, it's not just a wrapper for
something.
2014-10-12 21:36:17 +02:00
Victor Stinner
33f6abe4ae
asyncio doc: reformat create_server() doc
...
Fix also the reate_unix_connection() doc: the method is not support on Windows,
not need to mention that ssl is not support with ProactorEventLoop.
2014-10-12 20:36:04 +02:00
Victor Stinner
ed051594d7
asyncio doc: add TCP echo client/server using streams
2014-10-12 20:18:16 +02:00
R David Murray
2ac7a89843
#17325 : Improve distutils PyPI documentation.
...
Patch by Chris Jerdonek.
2014-10-12 13:14:12 -04:00
Georg Brandl
62b08136d7
Closes #22586 : clarify meaning of allow_fragments in urlparse.
2014-10-12 16:13:32 +02:00
Victor Stinner
5366434336
asyncio doc: enhance TCP client example
2014-10-12 11:35:09 +02:00
Victor Stinner
cfbea3a02e
asyncio doc: clarify how servers create protocol instances
2014-10-12 11:30:17 +02:00
Victor Stinner
c7edffdddd
asyncio doc: add UDP client and server examples
2014-10-12 11:24:26 +02:00
Victor Stinner
c2721b41d3
asyncio doc: use server.wait_closed() in TCP echo server example
2014-10-12 11:13:40 +02:00
Berker Peksag
edd6ec2dd3
Issue #22613 : Fix reprlib.Repr subclass example on Python 3.
...
Reported by Jacques Ducasse.
2014-10-12 05:11:16 +03:00
Nick Coghlan
36d8ef9cc7
Issue #21061 : correctly note redirect_stdout is reentrant
2014-10-12 10:25:00 +10:00
Victor Stinner
ccd8e34508
asyncio doc: socket.socketpair() is not available on Windows yet
2014-10-11 16:30:02 +02:00
Victor Stinner
04e6df330d
asyncio doc: add examples showing the 3 ways to wait for data from an open
...
socket
2014-10-11 16:16:27 +02:00
Victor Stinner
6888b96cee
asyncio doc: cleanup Hello World examples
2014-10-11 16:15:58 +02:00
Victor Stinner
5121a9ba4a
asyncio doc: the "Get HTTP headers" example now supports HTTPS
2014-10-11 15:52:14 +02:00
Georg Brandl
dbf8344404
Closes #18959 : move optparse and imp to new "superseded modules" chapter
2014-10-11 14:47:11 +02:00
Georg Brandl
e8ea355b72
Closes #21687 : delimiter in Py_SetPath is platform dependent
2014-10-11 14:36:02 +02:00
Georg Brandl
c5dd095a9b
Closes #21675 : fix ordering of description in library intro
2014-10-11 14:32:34 +02:00
Zachary Ware
a13dab47cb
Issue #15414 : Clean and correct the os.path.join docs.
...
In particular, correctly describe the behavior of ntpath.join.
Based on a patch by Dave Sawyer.
2014-10-10 16:03:14 -05:00
Terry Jan Reedy
f9bd920cfa
Issue 22603: add missing 'self'. Patch by Francisco Fernández Castaño.
2014-10-10 16:00:18 -04:00
Victor Stinner
cfb2a0a855
Issue #22564 : ssl doc: mention asyncio in the non-blocking section
2014-10-10 12:45:10 +02:00
Victor Stinner
d28fe8c8f4
Issue #22564 : ssl doc: mention how SSLSocket are usually created
2014-10-10 12:07:19 +02:00
Victor Stinner
3c3d3c73f3
Issue #22564 : ssl doc: use "class" marker to document the SSLSocket class
2014-10-10 12:06:51 +02:00
Victor Stinner
41f92c2818
Issue #22564 : ssl doc: document read(), write(), pending, server_side and
...
server_hostname methods and attributes of SSLSocket.
2014-10-10 12:05:56 +02:00
Victor Stinner
851a6cc071
Issue #22564 : ssl doc: fix typos
2014-10-10 12:04:15 +02:00
R David Murray
5f16f90d1b
#18176 : Change generic UCD PropList link to version specific link.
2014-10-09 20:45:59 -04:00
R David Murray
5bd62420f4
#18176 : fix another reference and add it to the makeunicodedata comment.
2014-10-09 17:39:48 -04:00
R David Murray
7445a383a6
#18176 : updated stdtypes UCD link, added reminder to makeunicodedata.
...
Patch by Alexander Belopolsky.
2014-10-09 17:30:33 -04:00
Victor Stinner
13d3aa502d
Closes #22580 : Fix documentation of PyUnicode_Tailmatch()
...
The result type is Py_ssize_t (and not int).
2014-10-09 11:11:25 +02:00
Berker Peksag
b2fdafe3d2
Issue #22576 : Fix signatures of FTP.storbinary() and FTP.storlines() methods.
...
The correct parameter name is "fp", not "file".
2014-10-08 13:15:04 +03:00
Larry Hastings
2ce95d7b7c
Merge from 3.4.2 release head back into 3.4 mainline.
2014-10-08 02:50:50 -07:00
Benjamin Peterson
57fb11b255
use source role instead of linking to svn
2014-10-06 21:10:25 -04:00
Georg Brandl
9205e9ebdc
Closes #16155 : fix a few errors in doctest output of the FAQ pages.
2014-10-06 17:51:09 +02:00
Georg Brandl
7fa4a8f15a
Closes #12148 : clarify "or's together option flags" in doctest docs.
2014-10-06 16:56:43 +02:00
Georg Brandl
4dd27a3edb
Closes #21782 : the default hash(x) is not exactly id(x) but derived from it.
2014-10-06 16:45:23 +02:00
Georg Brandl
a94ad1e508
Closes #10031 : overhaul the "imports" section of the programming FAQ.
...
Remove the advice to never use relative imports; it is a leftover from 2.x implicit relative imports.
Remove the advice to locally import modules in __init__, it is a strange practice.
Remove the advice to use "from ... import *" with some modules.
2014-10-06 16:02:09 +02:00
Georg Brandl
f6d6dc2e36
Clean up the docs of PyObject_IsSubclass and PyObject_IsInstance, and mention that they call the PEP 3119 methods.
2014-10-06 14:38:53 +02:00
Georg Brandl
a920b6d762
Closes #22507 : document that PyType_IsSubtype does not call __subclasscheck__.
2014-10-06 14:15:06 +02:00
Georg Brandl
eb7e8f607e
Document builtin classes as such, not functions.
2014-10-06 13:54:36 +02:00
Georg Brandl
97435166aa
Closes #22565 : fix argument types of PyErr_WarnEx.
2014-10-06 12:58:00 +02:00
Terry Jan Reedy
c6ad57608b
Issue #22546 : update doc for mini-language float None presentation type.
2014-10-06 02:04:33 -04:00
Larry Hastings
c6256e5f7d
Update pydoc topics and fix supsicious markup for 3.4.2 final.
2014-10-05 19:03:48 -07:00
Benjamin Peterson
1c262a6c75
PyObject not PyType ( closes #18494 )
2014-10-05 21:20:36 -04:00
Georg Brandl
340c749a3a
Closes #19477 : remove outdated documentation of tp_print type object slot.
2014-10-05 16:38:02 +02:00
R David Murray
9db487b31f
#14201 : Update ctypes docs to match behavior changed from 214b28d7a999.
...
Original patch by Erik Johansson, slightly updated by Meador Inge.
2014-10-04 18:25:07 -04:00
Nick Coghlan
5c4fbd5fdf
Realign packaging docs with PyPUG changes
2014-10-04 21:11:25 +10:00
R David Murray
bf92bceaaa
#14056 : Small improvements to the tarfile documentation.
...
Patch by Éric Araujo with help from Lars Gustäbel.
2014-10-03 20:18:48 -04:00
Zachary Ware
7280561b5b
Fix a few typo/grammar issues in the multiprocessing docs.
...
Reported by Scott Hinton on docs@.
2014-10-03 10:55:12 -05:00
Georg Brandl
3f1ef9efd5
Closes #18729 : minor markup improvement.
2014-10-02 12:37:50 +02:00
Georg Brandl
c0a8f8ce84
closes #22528 : add source links to symtable and compileall
2014-10-02 08:38:39 +02:00
Georg Brandl
ea7ec2b481
Remove unused and now removed config value.
2014-10-02 08:27:05 +02:00
Terry Jan Reedy
6e978d2754
Issue #21971 : Index and update turtledemo doc.
2014-10-02 00:16:31 -04:00
Terry Jan Reedy
1895f2b544
Issue 22492: Be explicit that print does not support binary mode files.
...
Original patch by Georg Brandl.
2014-10-01 15:37:42 -04:00
Georg Brandl
0428e6cc89
Remove old overridden version of a Sphinx CSS file.
...
All Python-specific styling is now in the theme anyway.
2014-10-01 19:41:31 +02:00
Georg Brandl
fd3a15a0cc
Make pydoctheme compatible with Sphinx 1.3 HTML output changes.
2014-10-01 19:28:23 +02:00
Ned Deily
14366f3a8e
Fix overlooked conf.py setting in flattening of Doc directory.
2014-09-30 18:41:37 -07:00
R David Murray
6bd68608ff
#21739 : mention subtle difference between loops and listcomps in tutorial.
...
We don't want to go into a full explanation of scopes at this point in the
tutorial, so we just mention that the loop creates or overwrites a persistent
variable while the listcomp doesn't. Not mentioning this would lead someone
to incorrectly assume loops and listcomps were *completely* equivalent, which
would confuse them later.
Original patch by Rose Ames, tweaked to remove the word 'scope'.
2014-09-30 21:25:38 -04:00
Terry Jan Reedy
b6271f2d2b
Issue 22465: grammar, number agreement.
2014-09-30 19:07:49 -04:00
Georg Brandl
97e9ec688c
Move Doc/tools/sphinxext content to Doc/tools, there is no need for the nested subdirectory anymore.
2014-09-30 22:51:30 +02:00
Georg Brandl
2b1a0a30c9
Dont define an empty SPHINXOPTS, which overrides a definition from the environment.
2014-09-30 22:23:57 +02:00
Georg Brandl
bae334cda9
Prepare sphinx extensions for 1.3.
2014-09-30 22:17:41 +02:00
Benjamin Peterson
45d929dc64
add link to pdb source ( closes #22528 )
2014-09-30 16:02:06 -04:00
R David Murray
12dc0d96e0
#20135 : FAQ entry for list mutation. (See also 6375bf34fff6.)
...
I accidentally committed this in 6375bf34fff6; this changeset addresses the
last review comments on the patch.
This is a perennial question and something someone opens a ticket for probably
every other month or so, so I'm surprised we didn't already have a FAQ entry
for it.
The original patch was written by M. Votz, refined first by Ezio Melotti and
further refined by me.
2014-09-29 10:17:28 -04:00
R David Murray
623ae29469
#10510 : Fix bug in forward port of 2.7 distutils patch.
...
Pointed out by Arfrever.
2014-09-28 11:01:11 -04:00
Berker Peksag
9c1dba2758
Revert #22251
2014-09-28 00:00:58 +03:00
Berker Peksag
3749404ba5
Issue #22251 : Fix ReST markup to avoid errors building docs.
2014-09-27 23:21:35 +03:00
R David Murray
9cc5fd7b59
#18854 : make it explicit that is_multipart does not mean 'multipart/xxx'.
...
Original patch (and the idea of using _structure) by Abhilash Raj.
2014-09-27 15:37:40 -04:00
R David Murray
1f3a88fe55
#20974 : Update version table in email intro.
...
Note that the email version string in 3.3 and 3.4 is inaccurate, since it
still exists but wasn't updated while the code was.
2014-09-27 14:59:36 -04:00
Berker Peksag
6c1f0ad665
Issue #17462 : Add a paragraph about advantages of argparse over optparse.
...
Patch by Anastasia Filatova.
2014-09-26 15:34:26 +03:00
Benjamin Peterson
efd713b82b
allow archives for rc releases to be built ( closes #22484 )
2014-09-24 20:22:24 -04:00
R David Murray
22dd8334cd
Improve English phrasing in asyncio task docs.
2014-09-24 11:09:09 -04:00
Benjamin Peterson
eb83ffe1b3
fix error in split() examples ( closes #22459 )
...
Patch by Raúl Cumplido.
2014-09-22 22:43:50 -04:00
Georg Brandl
90d76ca765
Closes #21431 : make docs depend on Sphinx 1.2 and fix pydoc-topics builder to
...
return Unicode strings on Python 3.
2014-09-22 21:18:24 +02:00
Jesus Cea
ca2e02cfe6
Typo: headeronly -> headersonly
2014-09-22 00:43:39 +02:00
Antoine Pitrou
afe8d0646c
Issue #21332 : Ensure that ``bufsize=1`` in subprocess.Popen() selects line buffering, rather than block buffering.
2014-09-21 21:10:56 +02:00
Georg Brandl
3f40c40dea
Doc: remove invalid uses of ":option:" which will emit warnings in Sphinx 1.3.
2014-09-21 00:35:08 +02:00
R David Murray
8a97896a76
#21091 : make is_attachment a method.
...
Since EmailMessage is a provisional API we can fix API bugs in a
maintenance release, but I used a trick suggested by Serhiy to
maintain backward compatibility with 3.4.0/1.
2014-09-20 18:05:28 -04:00
Benjamin Peterson
cbfaa7b9d3
standardize pep 466 relnote style
2014-09-19 17:27:03 -04:00
Benjamin Peterson
49d77fd58a
remove extra letter
2014-09-19 17:29:08 -04:00
Benjamin Peterson
ce30237493
whatsnew for pep 466 ssl backport
2014-09-19 17:23:21 -04:00
Vinay Sajip
2f1cd8a7fc
Issue #22436 : Improved documentation for getEffectiveLevel() and getLevelName().
2014-09-18 18:01:12 +01:00
Senthil Kumaran
15e4833662
Issue #16827 : Make Interpreter introduction section of the tutorial more
...
focussed and move advanced section and customization information to a separate
file called appendix.
Patch credits: Jamayla Wiley, Ya-Ting Huang and James Brewer.
2014-09-18 21:30:28 +08:00
Berker Peksag
2d510e3bab
Issue #14824 : Update Repr.repr_TYPE documentation to use correct name mangling implementation.
...
Patch by Chris Rebert.
2014-09-18 06:05:14 +03:00
Ethan Furman
f75805edb8
Issue21738: clarify usage of __new__ in Enum subclasses
2014-09-16 19:13:31 -07:00
Benjamin Peterson
7c8b89e156
make hg link secure
2014-09-13 01:44:34 -04:00
Vinay Sajip
d1d4fbff63
Issue #22386 : fixed regression.
2014-09-11 23:06:09 +01:00
Benjamin Peterson
6d46dff5b5
y2k compliance, lol ( closes #22380 )
2014-09-10 17:13:06 -04:00
Serhiy Storchaka
148679982f
Issue #22369 : Change "context manager protocol" to "context management protocol".
2014-09-10 23:43:41 +03:00
Nick Coghlan
1d52096d14
Issue #22295 : Adopt 'python -m pip' as the preferred invocation
2014-09-06 20:38:23 +10:00
Nick Coghlan
af117ed3d7
Issue #22346 : also include asyncio PEP 411 notice in 3.4
2014-09-06 19:43:06 +10:00
Serhiy Storchaka
848c8b29f6
Issue #20643 : Removed unneeded (and wrong) class directives.
2014-09-05 23:27:36 +03:00
Ned Deily
29020b155a
Issue #22320 : Fix broken link in the General Python FAQ.
...
Original patch by Josh Lynn.
2014-09-01 00:06:18 -07:00
Victor Stinner
41f3c3f226
Closes #22275 : asyncio: enhance documentation of OS support
2014-08-31 14:47:37 +02:00
Benjamin Peterson
e218bcbf39
getuid() returns real process id not effective ( closes #22307 )
2014-08-30 21:04:15 -04:00
Victor Stinner
d84fd73de2
Issue #22063 : Fix asyncio documentation of socket and pipe operations regarding
...
to non-blocking mode. The non-blocking mode does not matter when using a
ProactorEventLoop, only for SelectorEventLoop.
2014-08-26 01:01:59 +02:00
Victor Stinner
52bb949fd3
asyncio, tulip issue 203: Add _FlowControlMixin.get_write_buffer_limits() method
2014-08-26 00:22:28 +02:00
Victor Stinner
d71dcbb043
asyncio: update the doc
...
* dev: mention that the logging must be configured at DEBUG level
* streams: drain() has no more a strange return value, it's just
a standard coroutine
2014-08-25 17:04:12 +02:00
Terry Jan Reedy
ee55826072
Issue #13540 : add missing markup.
2014-08-23 22:21:47 -04:00
Terry Jan Reedy
65e3ecb3e2
Issue #22243 : fix except grammar in reference.
2014-08-23 19:29:47 -04:00
Terry Jan Reedy
004e87048a
Issue #22232 (partial fix): update Universal newlines Glossary entry.
2014-08-23 18:28:44 -04:00
Nick Coghlan
a5bbc2ea3d
Forward port PEP 466 What's New in 2.7 updates
2014-08-23 14:47:47 +10:00
Berker Peksag
eb265ab873
Issue #22150 : Fix deprecated-removed directive in Sphinx 1.2.
2014-08-22 18:24:29 +03:00
Zachary Ware
f9dd274692
Issue #22178 : Fix the date of the Windows epoch (Jan 1, 1601).
2014-08-11 15:00:48 -05:00
Victor Stinner
337e03ff78
Issue #22112 , asyncio doc: replace loop.create_task(coro) with
...
asyncio.async(coro), mention that asyncio.async() can be used to scheduler a
coroutine, and make it clear that create_task() is only available in Python
3.4.2 and later.
2014-08-11 01:11:13 +02:00
Raymond Hettinger
ac191ce1d3
Issue #22174 : Clean-up grammar and ambiguities in property() docs.
2014-08-10 10:41:25 -07:00
Raymond Hettinger
31b3683d9b
Issue #22180 : Remove weak example
2014-08-10 10:33:03 -07:00
Nick Coghlan
e4936b830c
Issue #21777 : separate docs for binary sequence methods
2014-08-09 16:14:04 +10:00
Ezio Melotti
79a1ffde9b
#22170 : avoid printing newlines twice in tutorial example.
2014-08-08 17:23:32 +03:00
Vinay Sajip
12d9ddf532
Issue #22130 : Corrected fileConfig() documentation.
2014-08-05 10:34:16 +01:00
Ezio Melotti
67f6d5f4d0
#21928 : clarify functools.wraps docs.
2014-08-05 08:14:28 +03:00
Ezio Melotti
e4aad5ab32
#18034 : update FAQ to suggest importlib.import_module instead of __import__. Patch by Wouter van Heyst.
2014-08-04 19:34:29 +03:00
Ezio Melotti
591176e544
#18588 : update the timeit examples to be consistent.
2014-08-04 17:01:16 +03:00
Raymond Hettinger
c6f22cc0a6
Remove unused leftover stray line
2014-08-04 00:21:11 -07:00
Raymond Hettinger
c0de59bfc3
Fix markup.
2014-08-03 23:44:30 -07:00
Raymond Hettinger
c566431bf0
Improve regex tokenizer example by using re.finditer().
...
Also, improve variable names and fix column numbers
in the generated output.
2014-08-03 23:38:54 -07:00
Jason R. Coombs
b3d4c212f7
Issue #13540 : Merge changes from 3.3
2014-08-03 15:26:58 -04:00
Jason R. Coombs
89e186f24e
Issue #13540 : Merge changes from 3.2
2014-08-03 15:26:32 -04:00
Jason R. Coombs
79690ac1d0
Issue #13540 : Update references to Action class to match syntax used for other classes in this file.
2014-08-03 14:54:11 -04:00
Raymond Hettinger
400daedb13
Fix whitespace in example.
2014-08-02 22:32:10 -07:00
Victor Stinner
ec2ce092a2
Issue #22063 : Mention in asyncio documentation that socket operations require
...
the socket to be non-blocking
2014-07-29 23:12:22 +02:00
Andrew Svetlov
f200ce6333
Document lock parameter for asyncio.Condition()
2014-07-26 19:50:37 +03:00
Zachary Ware
88a1977a08
Issue #22072 : Fix a couple of SSL doc typos. Patch by Alex Gaynor.
2014-07-25 13:30:50 -05:00
Victor Stinner
45cff66cf6
Issue #16133 : The asynchat.async_chat.handle_read() method now ignores
...
BlockingIOError exceptions. Initial patch written by Xavier de Gaye.
Document also in asyncore documentation that recv() may raise BlockingIOError.
2014-07-24 18:49:36 +02:00
Victor Stinner
992019c006
Backport os.rst documentation from Python 3.5.
2014-07-24 12:42:45 +02:00
Victor Stinner
6d4f4feca2
Issue #21813 : Enhance documentation of the os.stat_result class.
2014-07-24 12:42:16 +02:00
Andrew Svetlov
ca4f34366a
Fix incomplete sentence in asyncio docs.
2014-07-24 11:36:33 +03:00
Terry Jan Reedy
9ff41803af
Asyncio doc fixes: spelling, grammar, duplication.
2014-07-24 02:59:02 -04:00
Terry Jan Reedy
c935a9530c
Englich grammar nit.
2014-07-24 02:33:14 -04:00
Terry Jan Reedy
9f5388f24f
Fix doc example bug reported on python-list by Akshay Verma.
2014-07-23 20:30:29 -04:00
Zachary Ware
f012ba42fe
Issue #22002 : Make full use of test discovery in test sub-packages.
...
Adds `load_package_tests` function to test.support, uses it in test_asyncio,
test_email, test_json, test_tools, test_importlib and all test_importlib
sub-packages to implement test discovery.
2014-07-23 12:00:29 -05:00
Andrew Svetlov
588517ca63
Fix grammar
2014-07-23 11:27:17 +03:00
Serhiy Storchaka
17f5f817de
Issue #15759 : "make suspicious", "make linkcheck" and "make doctest" in Doc/
...
now display special message when and only when there are failures.
2014-07-22 10:24:25 +03:00
Jason R. Coombs
eb0ef415d5
Issue #13540 : Removed redundant documentation about Action instance attributes. Updated example and documentation per recommendations by Steven Bethard in msg149524.
2014-07-20 10:52:46 -04:00
Benjamin Peterson
102488b644
args doesn't need to be a tuple ( closes #17210 )
2014-07-19 16:34:33 -07:00
Mark Dickinson
e004c6cad5
Issue #22006 : Remove outdated _thread caveat. Thanks Dan O'Reilly for the report.
2014-07-19 21:45:06 +01:00
Zachary Ware
0069eac0e5
Issue #22004 : Correct an argument name.
2014-07-18 09:11:48 -05:00
Victor Stinner
d55b54d5c0
asyncio, tulip issue 190: Process.communicate() now ignores
...
ConnectionResetError too
2014-07-17 13:12:03 +02:00
Victor Stinner
cc996b5789
asyncio, tulip issue 190: Process.communicate() must ignore BrokenPipeError
...
If you want to handle the BrokenPipeError, you can easily reimplement
communicate().
Add also a unit test to ensure that stdin.write() + stdin.drain() raises
BrokenPipeError.
2014-07-17 12:25:27 +02:00
Berker Peksag
38bf87c7f2
Issue #21994 : Fix SyntaxError in the SSLContext.check_hostname documentation.
2014-07-17 05:00:36 +03:00
Zachary Ware
8faecbfb42
Fix a minor typo in the turtle docs. Found by Brandon Passmore on docs@.
2014-07-16 14:48:48 -05:00
Raymond Hettinger
8323f68f3e
Issue 21977: Minor improvements to the regexes in the tokenizer example.
2014-07-14 01:52:00 -07:00
Victor Stinner
4bfb14ac10
asyncio: Server.close() leaves client sockets open
2014-07-12 03:20:24 +02:00
Victor Stinner
8ebeb03740
asyncio: improve the documentation of servers
...
- Fix the documentation of Server.close(): it closes sockets
- Replace AbstractServer with Server
- Document Server.sockets attribute
2014-07-11 23:47:40 +02:00
Victor Stinner
778015b3bc
asyncio: enhance documentation of platform support
2014-07-11 12:13:39 +02:00
Berker Peksag
740c730086
Issues #21948 and #16040 : Fix typos.
2014-07-09 20:15:28 +03:00
Victor Stinner
aea82293be
Issue #21680 : Document asyncio event loops
2014-07-08 23:42:38 +02:00
Victor Stinner
530ef2f069
Update asyncio documentation
...
- Document the new create_task() method
- "Hide" the Task class: point to the create_task() method for interoperability
- Rewrite the documentation of the Task class
- Document the "Pending task destroyed"
- Update output in debug mode of examples in the dev section
- Replace Task() with create_task() in examples
2014-07-08 12:39:10 +02:00
Ezio Melotti
898eb82696
#20135 : move FAQ about mutable default arguments to the programming FAQs page.
2014-07-06 20:53:27 +03:00
Victor Stinner
63b21a8ffa
Closes #21921 : Fix ResourceWarning in the asyncio examples: close the event
...
loop at exit. Patch written by Vajrasky Kok (I modified also the "hello world"
example using a coroutine).
2014-07-05 15:38:59 +02:00
Berker Peksag
5021cb553c
Issue #21920 : Add a missing colon to the __main__ doc.
...
Patch by Stefan Tatschner.
2014-07-05 11:10:16 +03:00
Berker Peksag
3410af45f8
Add an index entry for exec() builtin.
...
Reported by Draic Kin on docs@.
2014-07-04 15:06:45 +03:00
Andrew Svetlov
0d50af45b6
Update docs about tp_richcompare
2014-07-03 16:07:17 +03:00
Raymond Hettinger
11cda47661
Fix guidance for subclassing collections.Set()
2014-07-03 00:31:30 +01:00
Andrew Svetlov
ee750d8f8d
Use try-finally idiom in example for locks in multiprocessing
2014-07-02 07:21:03 +03:00
Berker Peksag
fd6400a47d
Issue #13689 : Remove a dead link from howto/urllib.
2014-07-01 06:02:42 +03:00
Stefan Krah
bb458dbe59
Issue #21778 : Clarify use of flags if PyBuffer_FillInfo() is used inside a
...
getbufferproc().
2014-06-30 00:15:45 +02:00
Ezio Melotti
680241ec99
Fix indentation and class name in socket howto example.
2014-06-27 16:34:14 +03:00
Ned Deily
5c867018f0
Issue #21875 : Remove vestigial references to Classic Mac OS in os module docs.
2014-06-26 23:40:06 -07:00
Jesus Cea
0c4baa40ec
MERGE: Closes #20872 : dbm/gdbm/ndbm close methods are not documented
2014-06-25 13:06:07 +02:00
Jesus Cea
ac4b7f705a
Closes #20872 : dbm/gdbm/ndbm close methods are not documented
2014-06-25 13:05:31 +02:00
Senthil Kumaran
99597c4d12
Correct the quopri module documentation. Mention the correct types of the
...
parameters on encodestring and decodestring.
Patch by Petri Lehtinen.
2014-06-25 01:12:03 -07:00
Vinay Sajip
ab960f838c
Fixed typo in documentation.
2014-06-25 07:30:46 +01:00
Jesus Cea
ca5c7153de
MERGE: Closes #21441 : Reorder elements in documentation to match actual order in the code
2014-06-25 05:38:06 +02:00
Jesus Cea
e8ef8b7a20
Closes #21441 : Reorder elements in documentation to match actual order in the code
2014-06-25 05:37:17 +02:00
Raymond Hettinger
04ba0bb80c
Issue #11974 : Add tutorial section on class and instance variables
...
(Based on a patch from Renee Chu.)
2014-06-23 18:08:01 -07:00
Benjamin Peterson
f6f78e1d9d
clarify that islink only really works if python knows about symlinks ( closes #13143 )
...
Patch from Yayoi Ukai.
2014-06-22 17:59:35 -07:00
Benjamin Peterson
9b29acd1fe
some timezone doc improvements ( closes #16667 )
...
From the combined efforts of Berber Peksage, Andrew Svetlov, and Yayoi Ukai.
2014-06-22 16:26:39 -07:00
Victor Stinner
f328c7dc69
asyncio, Tulip issue 171: BaseEventLoop.close() now raises an exception if the
...
event loop is running. You must first stop the event loop and then wait until
it stopped, before closing it.
2014-06-23 01:02:37 +02:00
Victor Stinner
62511fd6d6
asyncio: document the debug mode
2014-06-23 00:36:11 +02:00
Victor Stinner
7b7120e159
asyncio: Enable the debug mode of event loops when the PYTHONASYNCIODEBUG
...
environment variable is set
2014-06-23 00:12:14 +02:00
Senthil Kumaran
4932e14542
issue 20091 - index entry for __main__ in runpy docs.
2014-06-20 01:37:53 -07:00
Ezio Melotti
642d4b654f
#21690 : fix a couple of links in the docs of the re module. Noticed by Julian Gilbey.
2014-06-20 00:52:11 +03:00
Victor Stinner
d143209d7f
Tulip issue 83: document more asyncio functions in docstrings
2014-06-19 17:11:49 +02:00
Victor Stinner
6bfd854ea8
Closes #21758 : asyncio doc: mention explicitly that subprocess parameters are
...
bytes or character strings
2014-06-19 12:50:27 +02:00
Zachary Ware
8909127af2
Fix typo pointed out by cocoatomo on docs@
2014-06-17 22:26:59 -05:00
Victor Stinner
64d750b36b
asyncio: Fix pyflakes errors
...
- Add a missing import
- Remove an unused import
- Remove unused variables
2014-06-18 03:25:23 +02:00
Zachary Ware
0aecc18bab
Fix typo reported by Jesse W on docs@
2014-06-16 11:13:01 -05:00
Terry Jan Reedy
b6d1f48c14
Issue #21559 : Add alternative (historical) reason for OverflowError.
2014-06-16 03:31:00 -04:00
Terry Jan Reedy
f2fb73f675
Issue #19362 : Tweek len() doc and docstring to expand the indicated range of
...
arguments. Original patch by Gareth Rees.
2014-06-16 03:05:37 -04:00
Benjamin Peterson
e58e0c7f33
clarify when the list of subdirectories is read ( closes #13779 )
2014-06-15 20:51:12 -07:00
Benjamin Peterson
ef8abfc082
document IOBase.__del__'s behavior ( closes #21764 )
...
Patch from Nikolaus Rath.
2014-06-14 18:51:34 -07:00
Vinay Sajip
e0d324d02b
Issue #21752 : Documented change to behaviour of logging.getLevelName().
2014-06-14 09:26:26 +01:00
Terry Jan Reedy
6926e3e835
Issue #21726 : Remove unnecessary and contextually wrong line.
2014-06-13 14:57:51 -04:00
Victor Stinner
b2788fe854
Issue #16136 : VMSError is done, bye bye VMS
2014-06-13 14:58:48 +02:00
Senthil Kumaran
e9738239ba
#21693 - Fix the broken link for pylons project.
2014-06-11 06:19:21 -07:00
Zachary Ware
5989511183
Issue #21688 : Give informative error message when hhc.exe cannot be found.
...
Initial patch by Olive Kilburn.
2014-06-10 12:07:45 -05:00
Victor Stinner
db74d982d4
Issue #21596 : asyncio.wait(): mention that the sequence of futures must not
...
be empty.
2014-06-10 11:16:05 +02:00
Victor Stinner
bb2fc5b2a5
Issue #21326 : Add a new is_closed() method to asyncio.BaseEventLoop
...
Add BaseEventLoop._closed attribute and use it to check if the event loop was
closed or not, instead of checking different attributes in each subclass of
BaseEventLoop.
run_forever() and run_until_complete() methods now raise a RuntimeError('Event loop is
closed') exception if the event loop was closed.
BaseProactorEventLoop.close() now also cancels "accept futures".
2014-06-10 10:23:10 +02:00
Victor Stinner
15386652bf
Issue #21700 : Fix asyncio doc, add DatagramProtocol
2014-06-10 09:19:26 +02:00
R David Murray
6ceca4e3d8
#20903 : clarify what happens when an smtp connection timeout occurs.
...
Patch by Milan Oberkirch.
2014-06-09 16:41:06 -04:00
Nick Coghlan
b1f59cecc9
Issue #21569 : Fix incorrect cross reference
2014-06-09 13:14:54 +10:00
Benjamin Peterson
96e0430dfb
document TokenError and unclosed expression behavior ( closes #12063 )
...
Patch by Amandine Lee.
2014-06-07 17:47:41 -07:00
Benjamin Peterson
4bb09c8432
specify that getuid() returns the real uid ( closes #10503 )
...
Patch by εσχατοκυριος.
2014-06-07 13:50:34 -07:00