Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign up[3.8] Fix typos in Misc/NEWS.d #17930
Conversation
Thanks for the PR @toonarmycaptain. Could you prefix the PR title with I would also consider adjusting to title to something more informative of the PR, such as I believe it is correct to specifically open the PR against the 3.8 branch, as changes to Misc/NEWS.d are typically only applied to branch's versions rather than all versions. This differs from other areas, where the changes should be applied to master and then backported to previous versions to all relevant locations. I'm not certain about the typo fix that adjusts the number of spaces between sentences. IIRC, it still renders exactly the same in reST; @merwok or @willingc might be able to clarify on that. The other changes LGTM though, thanks! |
This comment has been minimized.
This comment has been minimized.
Title change done. |
This comment has been minimized.
This comment has been minimized.
Thanks.
You can wait for additional feedback on that, but generally speaking we try to avoid making changes purely for the sake of consistency. This is significantly more important for changes to the source code, but it also applies to documentation or news changes. That's why I @ mentioned a couple of core developers that were especially experienced with reST, to check if the number of spaces makes a difference there. One small unnecessary change may not seem like a big deal, but it can really add up over time. PR review time comes at a premium, especially for a project ran almost entirely by voluntary efforts. It improves our workflow significantly when PRs have a more focused scope and avoid any unneeded changes. That being said, there's no harm at all in waiting for a second opinion; we have to wait on approval from a core developer before it can be merged. |
This comment has been minimized.
This comment has been minimized.
No problem, no need to bother the core devs unnecessarily! I just left it up to you as you were reviewing. Looking at https://docs.python.org/3.8/whatsnew/changelog.html#python-3-8-1-final, and this SO question, there's one space in my browser, not three, so it appears as if the extra whitespace is collapsed either when used to generate the HTML or when the HTML is rendered. |
This comment has been minimized.
This comment has been minimized.
Thanks! |
toonarmycaptain commentedJan 9, 2020
With reference to corrections to news in 3.9.0a2.rst backporting some typo corrections to 3.8.0/3.8.1.