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

Improve IDLE news handling #61708

Open
terryjreedy opened this issue Mar 21, 2013 · 13 comments
Open

Improve IDLE news handling #61708

terryjreedy opened this issue Mar 21, 2013 · 13 comments
Assignees
@terryjreedy
Labels
3.10 only security fixes docs Documentation in the Doc dir topic-IDLE type-feature A feature request or enhancement

Comments

@terryjreedy
Copy link
Member

BPO 17506
Nosy @terryjreedy, @ned-deily, @ezio-melotti, @serwy
Dependencies
  • bpo-17221: Resort Misc/NEWS
    		•

    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/terryjreedy'
closed_at = None
created_at = <Date 2013-03-21.07:58:43.004>
labels = ['expert-IDLE', 'type-feature', '3.10']
title = 'Improve IDLE news handling'
updated_at = <Date 2020-06-07.03:56:10.474>
user = 'https://github.com/terryjreedy'

    bugs.python.org fields:

    activity = <Date 2020-06-07.03:56:10.474>
actor = 'ned.deily'
assignee = 'terry.reedy'
closed = False
closed_date = None
closer = None
components = ['IDLE']
creation = <Date 2013-03-21.07:58:43.004>
creator = 'terry.reedy'
dependencies = ['17221']
files = []
hgrepos = []
issue_num = 17506
keywords = []
message_count = 10.0
messages = ['184858', '184859', '185612', '185980', '185989', '222994', '222995', '296388', '370862', '370872']
nosy_count = 5.0
nosy_names = ['terry.reedy', 'ned.deily', 'ezio.melotti', 'roger.serwy', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue17506'
versions = ['Python 3.10']
    @terryjreedy
    Copy link
    Member Author

    Idle news items should be collected together in one place and released both in an IDLE section of each Misc/NEWS and in each idlelib/NEWS.txt. Once a decision is made where to collect them originally, a script should be written to make appropriate copies. If someone volunteers, scattered entries in current Misc/NEWS could be collected together.

    @terryjreedy terryjreedy self-assigned this Mar 21, 2013
    @ezio-melotti
    Copy link
    Member

    I think it would be better to keep everything in an IDLE section in Misc/NEWS, and have something/someone extract the section(s) before the release. In Lib/idlelib/NEWS.txt we probably don't need to have separate sections for alphas/betas/rcs like we do in Misc/NEWS.

    @ezio-melotti ezio-melotti added the type-feature A feature request or enhancement label Mar 21, 2013
    @serwy
    Copy link
    Mannequin

    serwy mannequin commented Mar 31, 2013

    This is related to bpo-17221. I agree that news items need to be consolidated in both Misc/NEWS and Lib/idlelib/NEWS.txt.

    @ezio-melotti
    Copy link
    Member

    Setting bpo-17221 as a dependency. Once that is fixed it would be good to keep IDLE entries in Misc/NEWS, and copy them in Lib/idlelib/NEWS.txt before the release.

    @terryjreedy
    Copy link
    Member Author

    I put 1 or 2 items in idlelib/NEWS, but it does not really matter which way they go. I guess the greater separation in Misc/NEWS says they should go there first, as moving to idlelib would delete reliease info. I will move the one item over sometime, maybe after the big patch.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jul 14, 2014

    New changeset aa059a8fb55a by Terry Jan Reedy in branch '2.7':
    Issue bpo-17506: Synchronize Misc/NEWS and idlelib/NEWS.txt for 2.7.
    http://hg.python.org/cpython/rev/aa059a8fb55a

    @terryjreedy
    Copy link
    Member Author

    The items in Misc/NEWS and idlelib/NEWS.text were mostly disjoint.

    @terryjreedy
    Copy link
    Member Author

    To minimize news merge headaches, I have been pushing news items separately from IDLE patches, usually in batches of at least two. It has not been too much bother to copy from NEWS.txt to NEWS.

    If and when news handling is automated, I will request that items directed at the IDLE section also go to NEWS.txt.

    @terryjreedy
    Copy link
    Member Author

    Separate news items are now consolidated during the release process. But two issue with copying them. 1. They are not line wrapped, whereas news.txt is. 2. I don't always make (or keep) entries identical.

    @terryjreedy terryjreedy added 3.10 only security fixes and removed 3.7 (EOL) end of life labels Jun 6, 2020
    @ned-deily
    Copy link
    Member

    A suggestion: rather than trying to maintain a separate IDLE news file ("don't repeat yourself), it might be much easier to link to the IDLE section in each releases's formatted CHANGELOG now included in Python 3 docsets. For example:

    https://docs.python.org/3/whatsnew/changelog.html#idle
    or
    https://docs.python.org/3.8/whatsnew/changelog.html#idle

    Yes, users would have to scroll down to each release's IDLE section but I suspect that wouldn't be a huge burden considering how infrequently change files are consulted. To be even more useful, IDLE could first attempt to find the changelog in the Python installer's bundled copy of the docset like the F1 key does. For example, with the macOS installer, the corresponding file URL is:

    file:///Library/Frameworks/Python.framework/Versions/3.8/Resources/English.lproj/Documentation/whatsnew/changelog.html#idle

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    @terryjreedy
    Copy link
    Member Author

    On Windows, the .chm help file is no longer bundled by default. For me, F1 opens the python.org page.

    The changelog has a section for each release, including alpha, beta, and candidate releases. Trying to find everything new in 3.11, say, will require looking for an IDLE subsection in over 10 sections. What I would like is to prepend IDLE items for each new release to NEWS.txt as the changelog is rebuild. If and when I care enough, I may try to write a script.

    File whatsnew/changlog.rst has this line: .. miscnews:: ../build/NEWS, What file is executed to build the changelog html?

    @arhadthedev
    Copy link
    Member

    arhadthedev commented Jul 23, 2022 •
    edited

    What file is executed to build the changelog html?

    NEWS is built with blurb merge (https://github.com/python/core-workflow/blob/eac97e4cf5a4d73d80beeb779e889f8b93d074c9/blurb/blurb.py#L1029) then copied from Misc to a build directory. Probably it's better to plug here (so two NEWS files would be generated, one global and one IDLE-only).

    @terryjreedy
    Copy link
    Member Author

    Thank you. The function release loops through new blurb files, calling load_next on each. That parses the metadata and adds to list. At that point, it should be possible to call that add blurbs of type 'idle' to a separate list. Sometime after that, call another function that adds IDLE to idlelib/NEWS.txt. An issue is that this is a checked-in file so it has to be done 'right'. Also protect against files being scanned twice, if that is possible.

    @erlend-aasland erlend-aasland added the docs Documentation in the Doc dir label Jul 27, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @terryjreedy terryjreedy

    Labels
    3.10 only security fixes docs Documentation in the Doc dir topic-IDLE type-feature A feature request or enhancement
    Projects
    IDLE Issues
    Status: No status
    Milestone
    No milestone
    Development

    No branches or pull requests
    5 participants
    @arhadthedev @ned-deily @erlend-aasland @terryjreedy @ezio-melotti