f0d2ed73ac
minor grammar fixes (from docs@python.org)
2014-10-31 09:29:38 +01:00
4433ff958b
unittest.mock docs: fix use of default role
2014-10-31 07:59:37 +01:00
35903c809f
Sphinx extension: move imports to the module top
2014-10-30 22:55:13 +01:00
5aa761db52
pyporting howto: fix link target
2014-10-30 22:52:02 +01:00
884217cb60
distutils example: fix invalid rst in description string
2014-10-30 22:50:46 +01:00
3b4cf554e5
rstlint: make the "html leaked markup" regex a bit less sensitive
2014-10-30 22:49:54 +01:00
ef08bde8b8
minor markup fix: no inline markup is allowed in a module synopsis
2014-10-30 22:45:27 +01:00
2273b096ce
rstlint: we do not use svn anymore
2014-10-30 22:44:41 +01:00
95988f98ea
rstlint: add more directives we use
2014-10-30 22:35:55 +01:00
eb9106c928
Doc/contents: avoid false positive in rstlint
2014-10-30 22:31:32 +01:00
f2b56518f9
rstlint: recognize "deprecated-removed" directive
2014-10-30 22:30:01 +01:00
6b4c847c4f
Doc: fix default role usage (except in unittest mock docs)
2014-10-30 22:26:26 +01:00
b7354a65ce
Fixing broken links in doc, part 4: some more breaks and redirects
2014-10-29 10:57:37 +01:00
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
525d355984
Fixing broken links in doc, part 3: the rest
2014-10-29 10:26:56 +01:00
9bdcb3bc8a
Fixing broken links in doc, part 2: howto/
2014-10-29 09:37:43 +01:00
77fe77d4af
Fixing broken links in doc, part 1: faq/
2014-10-29 09:24:54 +01:00
728e4debd8
Fix external links to docs.python.org to use internal links instead.
2014-10-29 09:00:30 +01:00
5e722f698e
Remove now-dead link to IDLE debugger doc and add PyCharm to the commercial IDEs.
2014-10-29 08:55:14 +01:00
485922ea1f
Update "where is python.org hosted" FAQ.
2014-10-29 08:52:43 +01:00
e73778c1ac
Use https:// URLs when referring to python.org hosts.
2014-10-29 08:36:35 +01:00
46761ec7c2
Use https:// URLs in the HTML templates.
2014-10-29 08:36:15 +01:00
69a7203948
Doc readme: Fix markup, use https:// URLs.
2014-10-29 08:18:43 +01:00
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
a1f8486325
Move HTML templates to their own subdir.
2014-10-29 08:11:46 +01:00
e03902910c
Move Sphinx extensions to their own subdir.
2014-10-29 08:07:37 +01:00
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
3fdea95307
Remove deprecated and now unnecessary config value from conf.py.
2014-10-29 07:58:34 +01:00
fe85807d7f
Fix link to ABOP install chapter.
2014-10-28 23:00:25 +01:00
ce64cedff4
Fix module name.
2014-10-28 22:58:24 +01:00
946faa39e3
Using "-m module" is easier to read and understand than "-mmodule".
2014-10-28 22:54:24 +01:00
4ab5733685
Update Opensolaris advice to OpenCSW instead of defunct Blastwave.
2014-10-28 22:52:49 +01:00
2b07b0e868
Closes #22249 : use IPPROTO_TCP constant instead of SOL_TCP constant for getaddrinfo() proto param
2014-10-28 22:45:27 +01:00
c943e79384
Remove duplicate bullet point.
2014-10-28 22:40:48 +01:00
bb2d669292
Closes #22736 : move seealso to the bottom of the section about RE syntax.
2014-10-28 21:41:51 +01:00
89c558da00
Closes #22748 : there are no PyString C functions in 3.x.
2014-10-28 21:38:49 +01:00
01546a88b8
Closes #22749 : remove outdated advice to use clock() for accurate timing.
2014-10-28 21:35:35 +01:00
75f7490843
PYTHONY2K is long gone. Remove traces from the docs and manpage.
2014-10-28 17:15:10 +01:00
788f2adeae
#22196 : link to Enum in the nametuple documentation. Patch by Karmen Dykstra.
2014-10-28 15:07:14 +01:00
9b1e92f5a1
#22237 : document that sorted() is guaranteed to be stable. Initial patch by Martin Panter.
2014-10-28 12:57:11 +01:00
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
6d1c149a46
Issue #22723 : Make link styling more accessible.
...
Patch by Buck Golemon.
2014-10-25 05:20:49 +03:00
2cef300187
asyncio doc: fix typo in an example
2014-10-23 22:38:46 +02:00
c803bd84b5
Issue #22695 : Fix syntax of open() doc
2014-10-22 09:55:44 +02:00
4b4ddb2190
Issue #22660 : update various mentions in the ssl module documentation.
2014-10-21 00:14:39 +02:00
67503c5f1c
Docs: 'os.pwrite()' needs bytes, not strings
2014-10-20 16:18:24 +02:00
0fc08fd2c7
merge 3.3
2014-10-19 10:47:58 -04:00
f87f515057
Issue7186: document that __doc__ is not inherited by subclasses
2014-10-17 22:25:22 -07:00
7f314ed71b
asyncio doc: write simpler examples to introduce asyncio
2014-10-15 18:49:16 +02:00
7184bac544
Issue20386: SocketType is again socket.socket; the IntEnum SOCK constants are SocketKind
2014-10-14 18:56:53 -07:00
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
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
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
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
53dfcd86e9
issue22626: Use https:// for a link to the bug tracker
2014-10-13 12:55:21 -07:00
157da6fdd2
merge 3.3
2014-10-13 11:55:02 -04:00
ed8e3a987e
asyncio: add missing @coroutine decorator
2014-10-13 00:55:50 +02:00
ab1c853079
asyncio doc: update debug traces
2014-10-12 21:37:16 +02:00
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
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
ed051594d7
asyncio doc: add TCP echo client/server using streams
2014-10-12 20:18:16 +02:00
2ac7a89843
#17325 : Improve distutils PyPI documentation.
...
Patch by Chris Jerdonek.
2014-10-12 13:14:12 -04:00
62b08136d7
Closes #22586 : clarify meaning of allow_fragments in urlparse.
2014-10-12 16:13:32 +02:00
5366434336
asyncio doc: enhance TCP client example
2014-10-12 11:35:09 +02:00
cfbea3a02e
asyncio doc: clarify how servers create protocol instances
2014-10-12 11:30:17 +02:00
c7edffdddd
asyncio doc: add UDP client and server examples
2014-10-12 11:24:26 +02:00
c2721b41d3
asyncio doc: use server.wait_closed() in TCP echo server example
2014-10-12 11:13:40 +02:00
edd6ec2dd3
Issue #22613 : Fix reprlib.Repr subclass example on Python 3.
...
Reported by Jacques Ducasse.
2014-10-12 05:11:16 +03:00
36d8ef9cc7
Issue #21061 : correctly note redirect_stdout is reentrant
2014-10-12 10:25:00 +10:00
ccd8e34508
asyncio doc: socket.socketpair() is not available on Windows yet
2014-10-11 16:30:02 +02:00
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
6888b96cee
asyncio doc: cleanup Hello World examples
2014-10-11 16:15:58 +02:00
5121a9ba4a
asyncio doc: the "Get HTTP headers" example now supports HTTPS
2014-10-11 15:52:14 +02:00
dbf8344404
Closes #18959 : move optparse and imp to new "superseded modules" chapter
2014-10-11 14:47:11 +02:00
e8ea355b72
Closes #21687 : delimiter in Py_SetPath is platform dependent
2014-10-11 14:36:02 +02:00
c5dd095a9b
Closes #21675 : fix ordering of description in library intro
2014-10-11 14:32:34 +02:00
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
f9bd920cfa
Issue 22603: add missing 'self'. Patch by Francisco Fernández Castaño.
2014-10-10 16:00:18 -04:00
cfb2a0a855
Issue #22564 : ssl doc: mention asyncio in the non-blocking section
2014-10-10 12:45:10 +02:00
d28fe8c8f4
Issue #22564 : ssl doc: mention how SSLSocket are usually created
2014-10-10 12:07:19 +02:00
3c3d3c73f3
Issue #22564 : ssl doc: use "class" marker to document the SSLSocket class
2014-10-10 12:06:51 +02:00
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
851a6cc071
Issue #22564 : ssl doc: fix typos
2014-10-10 12:04:15 +02:00
5f16f90d1b
#18176 : Change generic UCD PropList link to version specific link.
2014-10-09 20:45:59 -04:00
5bd62420f4
#18176 : fix another reference and add it to the makeunicodedata comment.
2014-10-09 17:39:48 -04:00
7445a383a6
#18176 : updated stdtypes UCD link, added reminder to makeunicodedata.
...
Patch by Alexander Belopolsky.
2014-10-09 17:30:33 -04:00
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
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
2ce95d7b7c
Merge from 3.4.2 release head back into 3.4 mainline.
2014-10-08 02:50:50 -07:00
57fb11b255
use source role instead of linking to svn
2014-10-06 21:10:25 -04:00
9205e9ebdc
Closes #16155 : fix a few errors in doctest output of the FAQ pages.
2014-10-06 17:51:09 +02:00
7fa4a8f15a
Closes #12148 : clarify "or's together option flags" in doctest docs.
2014-10-06 16:56:43 +02:00
4dd27a3edb
Closes #21782 : the default hash(x) is not exactly id(x) but derived from it.
2014-10-06 16:45:23 +02:00
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
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
a920b6d762
Closes #22507 : document that PyType_IsSubtype does not call __subclasscheck__.
2014-10-06 14:15:06 +02:00
eb7e8f607e
Document builtin classes as such, not functions.
2014-10-06 13:54:36 +02:00
97435166aa
Closes #22565 : fix argument types of PyErr_WarnEx.
2014-10-06 12:58:00 +02:00
c6ad57608b
Issue #22546 : update doc for mini-language float None presentation type.
2014-10-06 02:04:33 -04:00
c6256e5f7d
Update pydoc topics and fix supsicious markup for 3.4.2 final.
2014-10-05 19:03:48 -07:00
1c262a6c75
PyObject not PyType ( closes #18494 )
2014-10-05 21:20:36 -04:00
340c749a3a
Closes #19477 : remove outdated documentation of tp_print type object slot.
2014-10-05 16:38:02 +02:00
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
5c4fbd5fdf
Realign packaging docs with PyPUG changes
2014-10-04 21:11:25 +10:00
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
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
3f1ef9efd5
Closes #18729 : minor markup improvement.
2014-10-02 12:37:50 +02:00
c0a8f8ce84
closes #22528 : add source links to symtable and compileall
2014-10-02 08:38:39 +02:00
ea7ec2b481
Remove unused and now removed config value.
2014-10-02 08:27:05 +02:00
6e978d2754
Issue #21971 : Index and update turtledemo doc.
2014-10-02 00:16:31 -04:00
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
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
fd3a15a0cc
Make pydoctheme compatible with Sphinx 1.3 HTML output changes.
2014-10-01 19:28:23 +02:00
14366f3a8e
Fix overlooked conf.py setting in flattening of Doc directory.
2014-09-30 18:41:37 -07:00
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
b6271f2d2b
Issue 22465: grammar, number agreement.
2014-09-30 19:07:49 -04:00
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
2b1a0a30c9
Dont define an empty SPHINXOPTS, which overrides a definition from the environment.
2014-09-30 22:23:57 +02:00
bae334cda9
Prepare sphinx extensions for 1.3.
2014-09-30 22:17:41 +02:00
45d929dc64
add link to pdb source ( closes #22528 )
2014-09-30 16:02:06 -04:00
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
623ae29469
#10510 : Fix bug in forward port of 2.7 distutils patch.
...
Pointed out by Arfrever.
2014-09-28 11:01:11 -04:00
9c1dba2758
Revert #22251
2014-09-28 00:00:58 +03:00
3749404ba5
Issue #22251 : Fix ReST markup to avoid errors building docs.
2014-09-27 23:21:35 +03:00
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
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
6c1f0ad665
Issue #17462 : Add a paragraph about advantages of argparse over optparse.
...
Patch by Anastasia Filatova.
2014-09-26 15:34:26 +03:00
efd713b82b
allow archives for rc releases to be built ( closes #22484 )
2014-09-24 20:22:24 -04:00
22dd8334cd
Improve English phrasing in asyncio task docs.
2014-09-24 11:09:09 -04:00
eb83ffe1b3
fix error in split() examples ( closes #22459 )
...
Patch by Raúl Cumplido.
2014-09-22 22:43:50 -04:00
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
ca2e02cfe6
Typo: headeronly -> headersonly
2014-09-22 00:43:39 +02:00
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
3f40c40dea
Doc: remove invalid uses of ":option:" which will emit warnings in Sphinx 1.3.
2014-09-21 00:35:08 +02:00
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
cbfaa7b9d3
standardize pep 466 relnote style
2014-09-19 17:27:03 -04:00
49d77fd58a
remove extra letter
2014-09-19 17:29:08 -04:00
ce30237493
whatsnew for pep 466 ssl backport
2014-09-19 17:23:21 -04:00
2f1cd8a7fc
Issue #22436 : Improved documentation for getEffectiveLevel() and getLevelName().
2014-09-18 18:01:12 +01:00
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
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
f75805edb8
Issue21738: clarify usage of __new__ in Enum subclasses
2014-09-16 19:13:31 -07:00
7c8b89e156
make hg link secure
2014-09-13 01:44:34 -04:00
d1d4fbff63
Issue #22386 : fixed regression.
2014-09-11 23:06:09 +01:00
6d46dff5b5
y2k compliance, lol ( closes #22380 )
2014-09-10 17:13:06 -04:00
148679982f
Issue #22369 : Change "context manager protocol" to "context management protocol".
2014-09-10 23:43:41 +03:00
1d52096d14
Issue #22295 : Adopt 'python -m pip' as the preferred invocation
2014-09-06 20:38:23 +10:00
af117ed3d7
Issue #22346 : also include asyncio PEP 411 notice in 3.4
2014-09-06 19:43:06 +10:00
848c8b29f6
Issue #20643 : Removed unneeded (and wrong) class directives.
2014-09-05 23:27:36 +03:00
29020b155a
Issue #22320 : Fix broken link in the General Python FAQ.
...
Original patch by Josh Lynn.
2014-09-01 00:06:18 -07:00
Georg Brandl
Ezio Melotti
Nick Coghlan
Berker Peksag
Victor Stinner
Antoine Pitrou
Jesus Cea
Benjamin Peterson
Ethan Furman
Alex Gaynor
R David Murray
Zachary Ware
Terry Jan Reedy
Larry Hastings
Ned Deily
Vinay Sajip
Senthil Kumaran
Serhiy Storchaka