Skip to content

bpo-32523: Simplifying news entries with multiple paragraphs. #8154

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.

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

Conversation

JulienPalard
Copy link
Member

@JulienPalard JulienPalard commented Jul 7, 2018

Also see: python/core-workflow#274

Having multiple paragraphs in a few news entry lead to inconsistent
spacing while rendered in HTML by mixing "visually compact lists"
(when no entry of the whole list contains multiple paragraphs) and
"sparse lists" (when at least one do).

Also NEWS entries should probably stay short.

https://bugs.python.org/issue32523

@JulienPalard
Copy link
Member Author

I'm studying how to fix further (old entries, other branches, ...) please do not merge ATM.

@JulienPalard
Copy link
Member Author

I enhanced blurb to get the line in the file where the issue is, so I was also able to fix issues in aggregate files, not only /next/. I'm now trying a local build.

@JulienPalard
Copy link
Member Author

It looks OK.

@@ -817,7 +814,6 @@ IDLE - make tests pass with zzdummy extension disabled by default.

Document how IDLE runs tkinter programs. IDLE calls tcl/tk update in the
background in order to make live

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This extra line was an error.

@@ -847,7 +843,6 @@ Rearrange IDLE condigdialog GenPage into Window, Editor, and Help sections.
.. section: IDLE

IDLE - Add docstrings and tests for outwin subclass of editor.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With hg, news items were expected to be the same as commit messages, and commit messages were expected to have a blank line after the title/subject line. This is still recommended for git commit messages, but apparently is handled for us in github by having separate title and message boxes when doing the squash merge commit.

I initially continued adding blank lines because I noticed that without them the message was re-wrapped so that there was no separate subject line, contrary to how news entries were once expected to look. Once I learned that NEWS entries were now supposed to be a single paragraph without a separate header, I stopped the blanks.

The affected events are '<<force-open-completions>>', '<<expand-word>>',
'<<force-open-calltip>>', '<<flash-paren>>', '<<format-paragraph>>',
'<<run-module>>', '<<check-module>>', and '<<zoom-height>>'. Any (global)
customizations made before 3.6.3 will not affect their keyset-specific
customization after 3.6.3. and vice versa.

Inital patch by Charles Wohlganger.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since Ned complained about a long IDLE news message for 3.7.0b5 or .0rc1, I started putting the long form message I think current users really need to see, like the above, in idlelib/NEWS.txt, viewed on About IDLE, and a condensed form in the general news entry. I also am adding more IDLE entries in What's New, including some x.y.z entries.

Putting acknowledgements on a new line, sometimes separated by a blank, was also standard practice. I mostly did not insert a blank except in a case like this. I see that others often did.

@@ -1,4 +1,3 @@
Allow ttk.Treeview.insert to insert iid that has a false boolean value.
Note iid=0 and iid=False would be same.
Patch by Garvit Khatri.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Editing error which blurb should fix or report as 'trailing blank'.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I spent an hour or two at the CPython core dev sprints trying to figure out how blurb could have possibly made this mistake. blurb is super-aggressive about reformatting your text, and even more aggressive about trailing whitespace.

@zooba figured out what happened: the author used "blurb" to originally create this entry, but didn't finish the last sentence with a period. @serhiy-storchaka asked the author to fix it. When the author added the trailing period, by editing the file manually in a text editor, they also introduced the trailing newline.

2e2defa

I guess it's too much to expect people to stop blaming blurb for other people's mistakes. But perhaps in the future you will keep this in mind, and not be so quick to blame blurb.

Also see: python/core-workflow#274

Having multiple paragraphs in a few news entry lead to inconsistent
spacing while rendered in HTML by mixing "visually compact lists"
(when no entry of the whole list contains multiple paragraphs) and
"sparse lists" (when at least one do).

Also NEWS entries should probably stay short.
@JulienPalard JulienPalard force-pushed the bpo-32523-multiple-paragraphs-in-news branch from 5b9d3c3 to ace9f65 Compare May 9, 2019 19:27
@JulienPalard JulienPalard merged commit 137be34 into python:master May 9, 2019
@JulienPalard JulienPalard deleted the bpo-32523-multiple-paragraphs-in-news branch June 16, 2019 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants