Commit graph

6050 commits

Author SHA1 Message Date
Georg Brandl
8ed75cd8e9 #22613: minor other fixes in library docs (thanks Jacques Ducasse) 2014-10-31 10:25:48 +01:00
Georg Brandl
2677faecf5 #22613: document Cmd.cmdqueue (thanks Jacques Ducasse) 2014-10-31 10:25:38 +01:00
Georg Brandl
717e02896f #22613: fix heading levels in tracemalloc docs (thanks Jacques Ducasse) 2014-10-31 10:21:07 +01:00
Georg Brandl
9b1b0e54e7 #22613: elaborate on arguments of shutil archival functions (thanks Jacques Ducasse) 2014-10-31 10:02:40 +01:00
Georg Brandl
f30132fdc9 #22613: explain what "buffer" is in the struct documentation (thanks Jacques Ducasse) 2014-10-31 09:46:41 +01:00
Georg Brandl
e4196d3f2e #22613: fix several factual errors in builtin docs (thanks Jacques Ducasse) 2014-10-31 09:41:46 +01:00
Georg Brandl
4433ff958b unittest.mock docs: fix use of default role 2014-10-31 07:59:37 +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
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
525d355984 Fixing broken links in doc, part 3: the rest 2014-10-29 10:26:56 +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
e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +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
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
01546a88b8 Closes #22749: remove outdated advice to use clock() for accurate timing. 2014-10-28 21:35:35 +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
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
Benjamin Peterson
9fc59c9fc2 make plural s lowercase 2014-10-19 10:47:49 -04: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
Benjamin Peterson
157da6fdd2 merge 3.3 2014-10-13 11:55:02 -04:00
Benjamin Peterson
77a75b3db1 note xmlrpclib doesn't verify certs (yet) 2014-10-13 11:54:50 -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
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