Take the new email package features out of provisional status

[bitdancer]

BPO	24277
Nosy	@warsaw, @bitdancer
Files	email_doc_rewrite.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/bitdancer'
closed_at = <Date 2016-09-08.16:50:56.168>
created_at = <Date 2015-05-24.14:10:33.319>
labels = ['type-feature', 'expert-email', 'docs']
title = 'Take the new email package features out of provisional status'
updated_at = <Date 2016-09-08.16:50:56.167>
user = 'https://github.com/bitdancer'

bugs.python.org fields:

activity = <Date 2016-09-08.16:50:56.167>
actor = 'r.david.murray'
assignee = 'r.david.murray'
closed = True
closed_date = <Date 2016-09-08.16:50:56.168>
closer = 'r.david.murray'
components = ['Documentation', 'email']
creation = <Date 2015-05-24.14:10:33.319>
creator = 'r.david.murray'
dependencies = []
files = ['44410']
hgrepos = []
issue_num = 24277
keywords = ['patch']
message_count = 7.0
messages = ['243986', '274674', '274675', '274940', '274941', '274947', '274948']
nosy_count = 3.0
nosy_names = ['barry', 'r.david.murray', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue24277'
versions = ['Python 3.6']

[bitdancer]

I plan to remove the provisional status of the new email features in 3.5. This is a documentation only change, but the documentation change is extensive (pretty much a complete rewrite of the package docs).

[bitdancer]

Obviously I quite missed the 3.5 deadline, and it is only thanks to the Core Sprint that I'm going to make the 3.6 deadline, but at least I'm making it.

There is one code change in this patch, changing the default behavior of as_string/str on EmailMessage (only) to be more sensible, and take advantage of the policy.utf8 flag to make str output more readable by default. Otherwise, it is simply (hah) a fairly complete documentation reorganization and rewrite giving primacy to the new API and demoting the old API to 'legacy'.

[bitdancer]

It is probably useless to try to review this as a diff. It maybe better to just commit it, and let people report any problems as bugs.

[python-dev]

New changeset b97118691363 by R David Murray in branch 'default':
bpo-24277: The new email API is no longer provisional.
https://hg.python.org/cpython/rev/b97118691363

[python-dev]

New changeset bd5b38e3db1a by R David Murray in branch 'default':
bpo-24277: What's New and news entries for previous commit.
https://hg.python.org/cpython/rev/bd5b38e3db1a

[python-dev]

New changeset ad297312a478 by R David Murray in branch 'default':
bpo-24277: Fix 3.4 whats new link broken by email doc changes.
https://hg.python.org/cpython/rev/ad297312a478

[python-dev]

New changeset d82927c18931 by R David Murray in branch 'default':
bpo-24277: Fix some incorrect backslashes in email example.
https://hg.python.org/cpython/rev/d82927c18931