Commit graph

5800 commits

Author SHA1 Message Date
Zachary Ware
9636e98b18 Merge several minor doc fixes from 3.4 2014-03-20 11:28:16 -05:00
Zachary Ware
dbd1c43e52 Fix spelling in enum docs.
"equivalant" was caught by Tobias Käs on docs@, "seperated" and "chartruese"
were discovered by a spell-checker.
2014-03-20 10:01:48 -05:00
Zachary Ware
a22ae21db6 Fix parameter name in docs for os.makedirs and os.removedirs.
Pointed out by Colin Davis on docs@.
2014-03-20 09:42:01 -05:00
Andrew Kuchling
c51da2b8a0 #14332: provide a better explanation of junk in difflib docs
Initial patch by Alba Magallanes.
2014-03-19 16:43:06 -04:00
Andrew Kuchling
2e3743cd30 #13437: link to the source code for a few more modules 2014-03-19 16:23:01 -04:00
Zachary Ware
088639936d Issue #20966: Fix Tkinter Resources link 2014-03-18 09:19:18 -05:00
Georg Brandl
f5c801fdca Fix option description that is a warning in new Sphinx versions. 2014-03-18 07:44:07 +01:00
Éric Araujo
0b1be1a3b1 Fix typo in example (#20963) 2014-03-17 16:48:13 -04:00
R David Murray
f93d3dfc50 closes #20960 2014-03-17 11:20:29 -04:00
Benjamin Peterson
2221f666eb merge 3.3 (#11448) 2014-03-16 15:56:24 -05:00
Benjamin Peterson
a48d9eaa5c improve set_tunnel docs (closes #11448)
Patch by Ryan Kelly, karl, and Nikolaus Rath.
2014-03-16 15:55:39 -05:00
Victor Stinner
7bdf786e74 Issue #20950: Fix typo asyncio doc, wait() has no self parameter
self parameter is implicit. Mention also that communicate() and wait() are
coroutines.
2014-03-16 21:29:31 +01:00
Antoine Pitrou
8bc7ef63a4 Close #16665: improve documentation for hex(). Patch by Jessica McKellar. 2014-03-16 02:13:07 +01:00
Antoine Pitrou
790bf0db77 Close #16665: improve documentation for hex(). Patch by Jessica McKellar. 2014-03-16 02:12:20 +01:00
R David Murray
b69c0c16cd whatsnew: final edit pass. 2014-03-14 18:31:07 -04:00
R David Murray
bcf7012d19 whatsnew: linkify some pip things, and explain why non-inheriting is good. 2014-03-13 19:53:38 -04:00
R David Murray
b895505625 whatsnew: HTTPError.headers (#15701). 2014-03-13 11:33:29 -04:00
Benjamin Peterson
5eea8a7780 remove unnecessary word (closes #19060)
Patch by Anastasia Filatova.
2014-03-12 21:41:35 -05:00
Éric Araujo
fa5e6e4773 Fix note markup (#16805).
Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.
2014-03-12 19:51:00 -04:00
Nick Coghlan
f7614d55a2 Close #19407: New installation & distribution guides
- based on pip and other PyPA tools
- includes references to the new Python Packaging User Guide
  where appropriate (and the relevant section is at least
  partially filled in)
- started new FAQ sections
- both guides aim to introduce users to basic open source
  concepts if they aren't aware of them
- existing guides have been relocated (now linked from the
  distutils docs) rather then removed, since there is
  some needed material that has yet to be relocated to the
  distutils docs as a reference for the legacy formats
2014-03-13 22:13:45 +10:00
Victor Stinner
2fb3b82706 asyncio doc: functions are coroutine, they don't return a coroutine
It's not exact, but easier to understand.
2014-03-13 10:58:03 +01:00
Victor Stinner
39930c9ca0 Close #20889: asyncio doc: Document acquire(), locked() and release() method of
Condition
2014-03-13 10:54:18 +01:00
Victor Stinner
d079d3a289 Close #20787: asyncio doc: fix typo. Patch written by akira. 2014-03-13 10:50:01 +01:00
Benjamin Peterson
605765fa32 merge 3.3 (#19060) 2014-03-12 21:42:04 -05:00
Éric Araujo
abdc16ee1b Merge 3.3 (#16805) 2014-03-12 19:51:50 -04:00
R David Murray
600e08dc1c Merge #20030: doc that TestLoader.discover returns a TestSuite. 2014-03-11 18:46:37 -04:00
R David Murray
ed5d95b76b #20030: doc that TestLoader.discover returns a TestSuite.
Patch by Lita Cho.
2014-03-11 18:46:00 -04:00
Benjamin Peterson
86deec1917 merge 3.3 2014-03-11 14:26:21 -05:00
Benjamin Peterson
8e4b3c7f55 improve algorithms_* documentation 2014-03-11 14:26:12 -05:00
Victor Stinner
11a4270b6a What's New in Python 3.4: Security improvements 2014-03-11 13:17:30 +01:00
Victor Stinner
637d2e9296 Issue #20888: improve "Pretty Top" example of tracemalloc, use linecache 2014-03-11 08:12:48 +01:00
R David Murray
0c18282da6 whatsnew: remove XXXs.
Can't figure out what the other issue was for the importlib
changes.  Did find a small typo in the reload doc, though.
2014-03-10 21:38:37 -04:00
R David Murray
9ea2a630fe whatsnew: deprecation of ElementTree XMLParser *html* and iterparse *parser*.
#17741
2014-03-10 18:09:54 -04:00
R David Murray
8df4ec70d3 whatsnew: os.open O_PATH and O_TMPFILE. 2014-03-10 15:48:22 -04:00
R David Murray
e8db162f62 whatsnew: PEP 424 implementation. 2014-03-10 15:00:33 -04:00
R David Murray
d840b8d613 whatsnew: multiprocessing start methods and context (#8713 and #18999)
Also tweaked the docs a bit to use our standard style for
versionadded/changed.  (I'm guessing there are other places
in the multiprocessing docs where similar tweaks should be made.)
2014-03-10 14:27:21 -04:00
R David Murray
c08383633a whatsnew: Message.set_param *replace*, Policy.content_manager.
Also cleaned up the email section and fixed some markup bugs in the
email docs.
2014-03-10 10:08:05 -04:00
R David Murray
2177be2c3a whatsnew: auidioop.byteswap (#16685). 2014-03-09 20:42:49 -04:00
R David Murray
1d342b2e8b whatsnew: plistlib new api and deprecations (#14455)
Also fixed the versionchanged/deprecation tags in the docs.
2014-03-09 15:09:04 -04:00
R David Murray
2dd0473722 whatsnew: SSLSocket.getpeercert new values returned. (#18379) 2014-03-09 12:55:58 -04:00
R David Murray
4e40cec924 whatsnew: sys.__interactivehook__. (#5845)
I decided to leave the (slightly expanded) Other Improvements
entry as well, since someone looking for command line behavior
changes isn't going to look in the 'sys' module section.
2014-03-09 12:03:30 -04:00
R David Murray
3d234837ed whatsnew: hmac *digestmod* accepts strings, and default is deprecated. (#17276) 2014-03-08 22:43:12 -05:00
R David Murray
c210de1ea1 whatsnew: base65 encodings. (#17618)
Also updated the base64 module title and introduction to adjust for
the fact that these new encodings are included.

Also adjusted the wording about the base64 alphabets (see
issue #20837).
2014-03-08 12:53:28 -05:00
R David Murray
cbf479ae64 whatsnew: sunau/aifc/wave writeframes[raw] accept any bytes-like (#8311) 2014-03-08 11:46:05 -05:00
R David Murray
5d6240e871 whatsnew: Wave_write handles unseekable files. (#5202)
Also clarify the documentation of this feature.
2014-03-08 11:14:29 -05:00
Nick Coghlan
1635578d5f Improve descriptions of introspection changes
Several of the introspection changes in Python 3.4 are indirect,
where inspect module changes affected pydoc, and those in turn
affected the help builtin. This update adds versionchanged
notes in the key locations, as well as more coverage in the
What's New document (in particular, a note in the porting
section regarding the expanded domain for inspect.getfullargspec).
2014-03-08 16:36:37 +10:00
R David Murray
8591563628 whatsnew: audioop accepts any bytes-like, rejects strings. 2014-03-07 21:35:31 -05:00
R David Murray
6c50101fc9 whatsnew: inet_pton/inet_ntop support windows (#7171).
Added versionchanged to docs.
2014-03-07 21:22:39 -05:00
R David Murray
47d083cf1a whatsnew: cp273 codec (#10907797)
Also updated the docs and added the aliases mentioned by the
references.
2014-03-07 21:00:34 -05:00
R David Murray
48b6b70b95 #10197: Update get[status]output versionchanged with actual version.
This was perhaps on the border between a bug fix and a feature since
the Python3 docs did not originally say it was unix only.  However, the
functions never worked anywhere but unix, and the docs were changed to
say it was unix only well before the windows support was added.

Unfortunately, windows support was added in 3.3.4 as well as 3.4.
That leaves us in the uncomfortable position of needing the tag to say
"version changed: 3.3.4" :(
2014-03-07 20:04:41 -05:00