Commit Graph

278 Commits

Author SHA1 Message Date
Jesus Cea cec25b01ec Typo 2014-03-17 19:00:48 +01:00
Larry Hastings 3101b70762 Final documentation fixes for 3.4.0 final. 2014-03-15 22:43:17 -07:00
Larry Hastings 0548f5c514 Regenerate pydoc_topics, fix markup errors, in preparation for 3.4.0 final. 2014-03-15 22:29:19 -07:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
R David Murray 6dfc632f1f whatsnew: difflib.isbjunk &c were removed, not deprecated.
Also move NEWS item to correct position (it was in 3.3).
2014-03-13 21:34:54 -04:00
R David Murray c4c7b1ccb6 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 b79b785a92 whatsnew: importlib deprecations.
This addresses issue #20199, if I got it right.  The deprecation and
replacement lists are based on the importlib documentation.
2014-02-22 14:28:46 -05:00
Yury Selivanov 026019f89b Mangle __parameters in __annotations__ dict properly. Issue #20625. 2014-02-18 12:49:41 -05:00
Larry Hastings ad88d7a26b Python 3.4.0rc1 release: Updated pydoc topics, fixed suspicious markup errors. 2014-02-10 04:26:10 -08:00
Nick Coghlan 72318b97f6 Issue #20500: clarify that invocation may be indirect 2014-02-09 12:05:13 +10:00
Nick Coghlan c0bc0b46bb Issue #20500: Note other public APIs with the new assertion 2014-02-09 12:00:01 +10:00
Nick Coghlan 3d7b3641d3 Note the new debug assertion in PyObject_Str 2014-02-09 10:57:34 +10:00
Nick Coghlan aa029dad50 Tweaks to What's New and some referenced docs 2014-02-09 10:10:24 +10:00
Nick Coghlan 96bb437ae8 Close #20563: Declare ipaddress API stable 2014-02-09 09:18:26 +10:00
R David Murray 45e732de70 whatsnew: read/write on closed SSL socket exception has changed. 2014-02-03 01:33:39 -05:00
R David Murray bf0ab8377a whatsnew: html.escape 10x faster, _gestalt module gone. 2014-02-03 01:14:03 -05:00
R David Murray a56d4e8ea1 whatsnew: hmac accepts more bytes types, importlib decode_source, stat in C. 2014-02-02 12:50:48 -05:00
R David Murray 5147e00c81 whatsnew: -m <namespace package>, plus 'using' doc updates. 2014-02-02 12:19:57 -05:00
R David Murray 900aeb7221 whatsnew: some more importlib replacements for imp functions.
get_magic->util.MAGIC_NUMBER, source_from_cache, and cache_from_source.
2014-02-02 11:32:31 -05:00
R David Murray 4885f49e7f whatsnew: filecmp.clear_cache, and reword description of cache in docs. 2014-02-02 11:11:01 -05:00
R David Murray 70e04f5fbc whatsnew: fix importlib.reload entry.
Turns out I committed a work-in-progress entry because of a time
gap between when I wrote it and when I committed.
2014-02-02 10:50:17 -05:00
R David Murray 8c561b52b2 whatsnew: move of reload, update new windows-only ssl functions entry. 2014-02-01 12:27:07 -05:00
Yury Selivanov 63da7c7b0c inspect.signature: Support duck-types of Python functions (Cython, for instance) #17159 2014-01-31 14:48:37 -05:00
Andrew Kuchling fe0f0b050d Typo fix 2014-01-31 12:17:53 -05:00
Yury Selivanov d82eddcf05 inspect.getfullargspec: Use inspect.signature API behind the scenes #17481 2014-01-29 11:24:39 -05:00
Yury Selivanov 2393dca472 inspect.signature: Use '/' to separate positional-only parameters from
the rest in Signature.__str__. #20356
2014-01-27 15:07:58 -05:00
Nick Coghlan 77b286b2cc Close #20105: set __traceback__ when chaining exceptions in C 2014-01-27 00:53:38 +10:00
R David Murray f1e4fdcf16 whatsnew: smtpd *map* argument, new ssl functions/methods.
Fleshed out Christian's placeholder for the new ssl methods.
2014-01-21 18:30:42 -05:00
Brett Cannon c089f70b54 Issue #18394: Document that cgi.FieldStorage now cleans up after its
'file' attribute properly in Python 3.4.

Thanks to Marcel Hellkamp for pointing out the oversight.
2014-01-17 11:03:19 -05:00
Ronald Oussoren 6db6653bbc Issue #14455: Fix some issues with plistlib
* Negative integer support in binary plists was broken

* Better exception for invalid data

* Fix the versionadded/versionchanged markup in the documentation

* Add the interface cleanup to what's new for 3.4
2014-01-15 11:32:35 +01:00
Zachary Ware 335957e087 Correct a typo. Found by Lauri Hakko on docs@. 2014-01-13 16:08:54 -06:00
R David Murray 0ae7ae1fc9 whatsnew: InspectLoader.get_code now concrete, b32decode raises binascii.Error.
And a news item rephrase.
2014-01-08 18:16:02 -05:00
R David Murray 66bf12a58e whatsnew: FileIO.readall performance, os.cpu_count.
And more news item tweaks.
2014-01-08 17:21:22 -05:00
R David Murray 0bce6e7462 whatsnew: expand 'dis' entry.
Also add one missing versionadded.
2014-01-07 14:30:17 -05:00
R David Murray a101bdb88c whatsnew: ssl getpeercert/do_handshake raise OSError, weakref __callback__.
Also add a missing word to gc entry, and delete a now-obsolete doc note
in the weakref __callback__ docs.  (Opened an issue for rewriting
the section that compares finalizers and __del__ method.)
2014-01-06 16:32:05 -05:00
R David Murray 9835827593 whatsnew: pydoc.Scanner removal, check_output input parm, operator.py.
Also fleshed out the entry on struct.iter_unpack.
2014-01-05 20:52:06 -05:00
R David Murray 410d320703 whatsnew: XMLPullParser, plus some doc updates.
I was confused by the text saying that read_events "iterated", since it
actually returns an iterator (that's what a generator does) that the
caller must then iterate.  So I tidied up the language.  I'm not sure
what the sentence "Events provided in a previous call to read_events()
will not be yielded again." is trying to convey, so I didn't try to fix that.

Also fixed a couple more news items.
2014-01-04 23:52:50 -05:00
R David Murray 244ad600e9 whatsnew: removal of TYPE_INT64 from marshal.
Also update news entry for SMTPException; when I changed it from
IOError to OSError I forgot to update the news item.
2014-01-04 21:17:52 -05:00
R David Murray 9cf617bff9 whatsnew: logging TimedRotatingFileHandler atTime parameter. 2014-01-04 18:55:01 -05:00
R David Murray 4908f4a151 whatsnew: from __future__ string exception, attribute UTF-32 decoder speedup.
And more news entry clarifications.
2014-01-04 18:07:20 -05:00
R David Murray b231b2be07 whatsnew: ppring string wrapping, string pickling optimization.
Also clarify some NEWS entries.
2014-01-04 17:11:23 -05:00
R David Murray 57fcf76d73 whatsnew: Mock mock_open readline(s); expand description of subtests feature. 2014-01-03 23:31:54 -05:00
Serhiy Storchaka 3079328d29 Reverted changeset b72c5573c5e7 (issue #15027). 2014-01-04 22:44:01 +02:00
Serhiy Storchaka 583a93943c Issue #15027: Rewrite the UTF-32 encoder. It is now 1.6x to 3.5x faster. 2014-01-04 19:25:37 +02:00
R David Murray e608255328 whatsnew: consistently use 3 blanks between major sections. 2 for minor. 2014-01-03 16:15:45 -05:00
R David Murray 59171722f0 whatsnew: make bullet list presentation style consistent. 2014-01-03 15:52:22 -05:00
R David Murray db085f56b9 whatsnew: unittest discovery sorting, urlllib Request getter/setter removals. 2014-01-03 15:46:24 -05:00
R David Murray a2924cabaf whatsnew: porting note for HTTP[S]Connection strict parameter removal.
It was discussed in issue #17460 whether or not to make the remaining
arguments keyword only so that things would fail noisily if someone was still
using positional parameters, but no decision was made and we are now well past
the Beta API change deadline.
2014-01-03 14:06:01 -05:00
R David Murray 0056936a4b whatsnew: deprecation of HTTPConnection's strict parameter. 2014-01-03 13:04:25 -05:00
R David Murray 42fa110035 whatsnew: unittest import time SkipTest reported as skip not error. 2014-01-03 13:03:36 -05:00
R David Murray a475a8d313 whatsnew: http.server send_error explain parameter.
Also rewrote the send_error description for clarity and correct English.
2014-01-03 13:03:00 -05:00
Martin v. Löwis 24e43308b7 * Issue #16113: Remove sha3 module again.
Patch by Christian Heimes, with modifications.
2014-01-03 14:05:06 +01:00
R David Murray 9025f1c5c4 whatsnew: sqlite3 uri parm, unittest.main defaultTest, ftplib.Netrc deprecation 2014-01-02 13:44:18 -05:00
R David Murray 33ef1aeb1e whatsnew: mock called_with improvements, socket CAN_BCM support.
Also reworded the other entries in the socket section of whatsnew, as
well as a couple of unrelated news entries.
2013-12-31 16:04:50 -05:00
R David Murray 8b2d68245e whatsnew: random.getrandbits performance.
Also fix a NEWS file issue number error, and some spacing fixes in whatsnew.
2013-12-31 15:06:05 -05:00
R David Murray d592bb2dc4 whatsnew: afic.open supports 'with'. 2013-12-31 13:45:38 -05:00
R David Murray fced3ec2db whatsnew: argparse FileType accepts errors and encodings args. 2013-12-31 11:18:01 -05:00
R David Murray 2bc930f044 whatsnew: epoll supports with.
Also reworded the description of the feature in the docs.
2013-12-31 11:17:21 -05:00
Christian Heimes f598558afb Fixed typo (thx Arfrever) 2013-12-30 09:33:46 +01:00
R David Murray 2691ee6183 whatsnew: abc.ABC. Also add issue number to news entry and reword. 2013-12-28 23:15:12 -05:00
R David Murray 473f45b4bc whatsnew: rewrite urllib, doctest, and poplib sections.
Also collapse redundant versionadded/versionchanged markup in
poplib.stls entry.
2013-12-27 17:01:16 -05:00
R David Murray d26538163e whatsnew: importlib cleanup and source_to_code add; python partial impl. 2013-12-27 14:06:15 -05:00
R David Murray 0e814634e5 whatsnew for gc.get_stats, plus doc tweaks.
Clarified the "At the moment" wording, and added the get_stats entry in the
module summary that Serhiy noted was missing at the end of issue 16351.

Given that pydoc lists all the function docstrings, I'm not sure that module
summary section is actually needed; but, it is probably better to address that
when the module is converted to use Argument Clinic.  In the meantime we
should keep the list complete.
2013-12-26 15:11:28 -05:00
R David Murray 575fb31955 shelf in with stmt, fish/csh in venv, ElementTree short_empty_elements keyword.
Also added versionadded for for fish/csh, fixed indentation of versionadded
for ElementTree.write, and make the behavior of shelf as a context manager
explicit in the docs.
2013-12-25 23:21:03 -05:00
R David Murray 6e39015f61 pty.spawn returns os.waitpid; optimization of BZ2File and LZMAFile. 2013-12-24 22:28:04 -05:00
R David Murray 3edcc7832e #16832: s/integer/object/ in docs/docstring, and add whatsnew entry. 2013-12-24 16:13:32 -05:00
R David Murray 5ea95249d5 idle -n deprecation, fix case of pickle section. 2013-12-24 15:59:57 -05:00
R David Murray d74d09ab4a Neaten up structure of major sections.
Also move tick_counter from deprecated section to removed section.
2013-12-24 15:33:02 -05:00
R David Murray 076deadd81 Move no-longer-supported operating systems into 'removed' section. 2013-12-24 14:59:50 -05:00
R David Murray e7cf678ad2 Use title case for all section titles except module names. 2013-12-24 14:51:25 -05:00
R David Murray d17aba7139 sys.getallocatedblocks + regrtest -R, make coverage-report, SO macro goes away. 2013-12-24 14:46:23 -05:00
R David Murray 061efb175f Use endash in PEP callouts.
Despite Serhiy's suggestion in issue18529, the emdash just looks
too long to me, at least in my browser.  This usage case is sort
of halfway between endash (connective) and emdash (pause/separator).
2013-12-24 12:35:59 -05:00
R David Murray 6dd1830c25 Move argument clinic into its own section, like the other PEPs. 2013-12-24 12:23:56 -05:00
R David Murray d91ba206a2 Mention Windows 2000 and OS/2 drops, python-config as shell script. 2013-12-24 12:13:44 -05:00
R David Murray 72420ff3ce Mention PATHEXT and removed Misc dirs; clarify wording of a NEWS entry. 2013-12-24 10:46:44 -05:00
R David Murray 347f9c7457 Make the 'read on' sentence cover more ground. 2013-12-23 21:30:06 -05:00
R David Murray bcaaecfe1e Move other improvements and optimization sections above deprecated.
This arrangement means the sections that have summaries come
first, and everything else comes after those.
2013-12-23 21:23:36 -05:00
R David Murray 4d48f2a6e7 Collapse 'python invocation changes' into 'other improvements'. 2013-12-23 21:21:09 -05:00
R David Murray 9217dadd12 Link new module summary entries to their description sections. 2013-12-23 21:08:28 -05:00
R David Murray 68790662fc Add pep 435 summary entry in new required features, and ensurepip description.
Also added a note about platform packagers not being required to install
pip by default, if they provide an appropriate pip hook, to the PEP
description section.
2013-12-23 11:17:51 -05:00
R David Murray f9976e7254 Add link to selectors description from its summary line. 2013-12-23 10:32:02 -05:00
R David Murray 8d85678d5c Make summary entry format consistent (always end with pep or issue in parens). 2013-12-23 10:28:57 -05:00
Serhiy Storchaka 2a6145290b Removed spaces before commas and periods. 2013-12-23 18:21:57 +02:00
R David Murray 3f122d6f44 Mention deprecation and porting sections in intro. 2013-12-22 21:09:16 -05:00
R David Murray f85b2a8dc7 Reflow 'modulespec' paragraphs. 2013-12-22 21:06:13 -05:00
R David Murray e9b74d45d3 Make mailing list thread reference an inline link, reword i.e. abbreviation. 2013-12-22 21:05:04 -05:00
R David Murray 809487e5f5 Make the organization of the body and the summary have parallel structure.
This means I moved the 'new expected features' section to the top of the
summary, and made a new section with the same name at the start of
the body, turning the previous top level sections there into subsections.

I also added a line to the new first summary section for modulespec (pep 451).
2013-12-22 20:49:40 -05:00
R David Murray 8f7664ab15 Add description of marshal changes. 2013-12-22 20:40:11 -05:00
R David Murray a93ca971a5 Be consistent in how PEPs are referenced throughout the summary section. 2013-12-22 14:10:21 -05:00
R David Murray ca7946193f Rewrite module-globals summary entry, and expand the full description a bit. 2013-12-22 14:05:11 -05:00
R David Murray 2aa9d52ed2 Make argument clinic summary entry parallel to other PEP entries.
The existing entry repeated the same info that was in the body text, which
means it didn't satisfy the sections "brevity" requirement :)
2013-12-22 13:57:45 -05:00
R David Murray c16dfe1837 Make CPython PEP summary entry links consistent, add pep 456 discussion. 2013-12-21 12:32:10 -05:00
Christian Heimes af01f66817 Issue #16136: Remove VMS support and VMS-related code 2013-12-21 16:19:10 +01:00
R David Murray 26b80cfde0 Add link from email summary entry to entry in changed module section. 2013-12-20 17:26:52 -05:00
R David Murray ac18622126 Add links to discussion of multiprocessing spawn/forkserver feature. 2013-12-20 17:23:57 -05:00
R David Murray 748bad2cd0 Tidy up ssl whatsnew references, make ssl section formatting consistent.
Also remove some extra blank lines in the ssl doc acctions for tls1.1/1.2,
and reflow a paragraph.
2013-12-20 17:08:39 -05:00
R David Murray c054040f86 Add link from pickle protocol 4 in summary to the section about it. 2013-12-20 16:38:09 -05:00
R David Murray cde1a06a54 Include sha3 addition in hashlib section of whatsnew.
And link to it from the summary, and link to the Hash Algorithms
section of hashlib from the linked description.
2013-12-20 16:33:52 -05:00
R David Murray a17e0d873a No need for single para descriptions to have separate contributed by para. 2013-12-20 16:12:28 -05:00
R David Murray e0f7a78877 whatsnew: s/no new syntax features planned/no new syntax features added/ 2013-12-20 16:04:29 -05:00