Commit Graph

5783 Commits

Author SHA1 Message Date
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
Benjamin Peterson 5eea8a7780 remove unnecessary word (closes #19060)
Patch by Anastasia Filatova.
2014-03-12 21:41:35 -05:00
Éric Araujo abdc16ee1b Merge 3.3 (#16805) 2014-03-12 19:51:50 -04:00
Éric Araujo fa5e6e4773 Fix note markup (#16805).
Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.
2014-03-12 19:51:00 -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
R David Murray 95b696a010 #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:17 -05:00
R David Murray 6674ac0873 whatsnew: ipaddress is_global
Also tweaked the docs a bit and added the missing entry for
the ipv6 is_global.
2014-03-06 11:51:37 -05:00
R David Murray 83db8fc3cc whatsnew: improve PyZipFile filterfuc entry, and its docs (#19274). 2014-03-05 10:48:01 -05:00
Nick Coghlan dc855b7b1f Close #20839: pkgutil.find_loader now uses importlib.util.find_spec 2014-03-04 20:39:42 +10:00
Ethan Furman c913a7a6f6 Issue20653: fix ReST for Enum 2014-03-03 15:02:04 -08:00
Ethan Furman 9c45444727 Close issue20653: improve functional API docs; minor code changes 2014-03-03 12:42:52 -08:00
Victor Stinner f70200e5a9 Close #20814: doc: Fix "Pretty top" example of tracemalloc 2014-03-03 11:57:57 +01:00
R David Murray 9c0c101ee4 whatsnew: unittest discover works on namespace packages (#17457).
I also added the docs that never got committed, editing the patch provided by
Claudiu.

I collapsed the now three versionchanged directives for discovery into one.  I
tried several different styles for this.  The most obvious is a bulleted list,
but currently the only way I could find to produce that is to have *something*
appear on the versionchanged line after the colon, which combined with the
blank space before the bulleted list just looks wrong.  I also tried the
current single-line-three-sentences version with bullet characters before each
sentence, and I almost went with that as it made it clear that the three
sentences are independent.  But I decided to just go with the sentences for
simplicity reasons.
2014-03-01 11:57:58 -05:00
Andrew Kuchling 98f2bbf794 #16135: remove mentions of OS/2 from the documentation 2014-03-01 07:53:28 -05:00
Brett Cannon acc74e6c63 Issue #20650: Tweak some awkward wording. 2014-02-28 10:06:18 -05:00
R David Murray 871119eb2f whatsnew: fix textwrap/shorten entry, and improve the related docs.
I had incorrectly added back the shorten method when I initially
made the whatsnew entry, but the shorten function docs were not
correct according to the code.  I also improved the wording in
general.
2014-02-27 18:01:43 -05:00
Zachary Ware 5ea5d2c3f7 Issue #20759: Fix some typos in the mock docs. 2014-02-26 09:34:43 -06:00
Zachary Ware 984689821d Close #20759: Fix some typos in the mock docs. (Merge with 3.3) 2014-02-26 09:38:39 -06:00
R David Murray 13cc883aaa whatsnew: DynanicClassAttribute (#19030), Py_SetStandardStreamEncoding (#16129)
Adding missing docs for DynamicClassAttribute by copying the docstring.  The
doc entry could stand some expansion, which I will note on the issue.
2014-02-25 16:03:14 -05:00
Antoine Pitrou ef85119618 Issue #20765: Add missing documentation for PurePath.with_name() and PurePath.with_suffix(). 2014-02-25 20:33:02 +01:00
R David Murray 7cae336890 whatsnew: Request.method can be overridden in subclasses (#18978).
Jason doced the change in the constructor *method* description, but
not the description of Request.method, so I added the change there
as well.
2014-02-25 10:22:50 -05:00
Guido van Rossum 3e97585b3e Clarify that flow control works for datagrams, except on BSD. 2014-02-24 14:31:25 -08:00