Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PEP 466: Python 2.7 What's New preamble changes #65768

Closed
ncoghlan opened this issue May 24, 2014 · 11 comments
Closed

PEP 466: Python 2.7 What's New preamble changes #65768

ncoghlan opened this issue May 24, 2014 · 11 comments
Assignees
@ncoghlan
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@ncoghlan
Copy link
Contributor

BPO 21569
Nosy @gvanrossum, @brettcannon, @terryjreedy, @ncoghlan, @benjaminp, @alex
Files
  • py27_whats_new_preamble_changes.diff: Initial proposal for What's New changes
  • py27_whats_new_preamble_changes_v2.diff: Address open questions & Ezio's comments
    		•

    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/ncoghlan'
closed_at = <Date 2014-06-07.14:02:38.658>
created_at = <Date 2014-05-24.10:26:32.435>
labels = ['type-feature', 'docs']
title = "PEP 466: Python 2.7 What's New preamble changes"
updated_at = <Date 2014-06-09.03:30:51.884>
user = 'https://github.com/ncoghlan'

    bugs.python.org fields:

    activity = <Date 2014-06-09.03:30:51.884>
actor = 'python-dev'
assignee = 'ncoghlan'
closed = True
closed_date = <Date 2014-06-07.14:02:38.658>
closer = 'ncoghlan'
components = ['Documentation']
creation = <Date 2014-05-24.10:26:32.435>
creator = 'ncoghlan'
dependencies = []
files = ['35417', '35422']
hgrepos = []
issue_num = 21569
keywords = ['patch']
message_count = 11.0
messages = ['219031', '219039', '219405', '219433', '219470', '219473', '219938', '219939', '220051', '220078', '220079']
nosy_count = 8.0
nosy_names = ['gvanrossum', 'brett.cannon', 'terry.reedy', 'ncoghlan', 'benjamin.peterson', 'Arfrever', 'alex', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue21569'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5']
    @ncoghlan
    Copy link
    Contributor Author

    Some proposed changes to the introductory section of the Python 2.7 What's New document. Key changes:

    • I updated the Future of Python 2.x section to describe the status quo, rather than preserving the original speculation from 2010
    • I added a new section to record the changes made in maintenance releases
    • I moved the DeprecationWarning change down to its own section, since it is really independent of Python 2.7 being the last release

    Open questions:

    • the current wording makes it clear that while it's hard to get features backported, PEP-466 isn't necessarily a one time deal. I'm open to changing that to instead just describe PEP-466 as is, without saying anything about using the PEP process to get other changes backported
    • I currently have the "New Features in Maintenance Releases" section near the top. Since it's hyperlinked from the "Future of Python 2.x" section anyway, perhaps I should move it towards the end instead?

    It occurred to me while writing this that we'll potentially have an influx of conservative Python users reading the doc this year, as RHEL 7 and CentOS 7 become generally available, finally upgrading the default Python in that ecosystem to 2.7.

    @ncoghlan ncoghlan self-assigned this May 24, 2014
    @ncoghlan ncoghlan added docs Documentation in the Doc dir type-feature A feature request or enhancement labels May 24, 2014
    @ncoghlan
    Copy link
    Contributor Author

    Added Brett to the nosy list for feedback, since the porting guide is mostly his work.

    @terryjreedy
    Copy link
    Member

    Did you intend to upload a diff with the current changes?

    My answers:

    • Just describe 466. Don't invite trouble.
    • Move the section to its logical place in temporal order, with a clear link.

    @ncoghlan
    Copy link
    Contributor Author

    Ah, that *would* explain the lack of comments. I'll upload the missing
    patch later today.

    @ncoghlan
    Copy link
    Contributor Author

    New patch, with the new section moved to the end of the file, just before the acknowledgements.

    It now has subsections for each relevant PEP, as Ezio's comments made me realise that PEP-434 (the IDLE consistency PEP) also deserved a mention.

    I'm happy with this version, so unless someone spots a glaring error in the next few days, I'll push it live.

    @terryjreedy
    Copy link
    Member

    I think the Idle section is such a great idea I propose to add something similar to future What's New for 3.x. See bpo-21621.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jun 7, 2014

    New changeset 7c28b3a92f40 by Nick Coghlan in branch '2.7':
    Updates to Python 2.7 What's New preamble
    http://hg.python.org/cpython/rev/7c28b3a92f40

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jun 7, 2014

    New changeset d23cea976f46 by Nick Coghlan in branch '3.4':
    Issue bpo-21569: sync Python 2.7 What's New with 2.7 version
    http://hg.python.org/cpython/rev/d23cea976f46

    New changeset b167df2912d6 by Nick Coghlan in branch 'default':
    Merge issue bpo-21569 from 3.4
    http://hg.python.org/cpython/rev/b167df2912d6

    @ncoghlan ncoghlan closed this as completed Jun 7, 2014
    @Arfrever
    Copy link
    Mannequin

    Arfrever mannequin commented Jun 8, 2014

    These changes caused this warning (at least on default branch) from Sphinx:

    ${cpython_working_copy}/Doc/whatsnew/2.7.rst:442: WARNING: undefined label: argparse-from-optparse (if the link has no caption the label must precede a section header)

    @ncoghlan
    Copy link
    Contributor Author

    ncoghlan commented Jun 9, 2014

    Huh, I thought I fixed that before pushing. Maybe I missed a commit after
    editing...

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jun 9, 2014

    New changeset 454d4a9a3088 by Nick Coghlan in branch '3.4':
    Issue bpo-21569: Fix incorrect cross reference
    http://hg.python.org/cpython/rev/454d4a9a3088

    New changeset 524d73b8f29e by Nick Coghlan in branch 'default':
    Issue bpo-21569: merge from 3.4
    http://hg.python.org/cpython/rev/524d73b8f29e

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @ncoghlan ncoghlan

    Labels
    docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @ncoghlan @terryjreedy