GH-101777: queue.rst: use 2 spaces after a period to be consistent.
#102143
Conversation
|
If you saw another instance, then yes, I think you should correct that one, too. |
OTheDev
changed the title
PriorityQueue docs. Use 2 spaces after a period to be consistent.queue.rst: use 2 spaces after a period to be consistent.
|
The most recent commit ensures this rule is followed consistently across the file. There are other issues I found. For example, the maximum line length of 80 stipulated in the devguide is not adhered to throughout the file. But I haven't seen this rule consistently enforced. My aim was to keep the diff to a minimum. |
|
Can we please not start encouraging PRs like this? IMO this is churn and nothing else. Can we please just close this PR, @ericvsmith? (Sorry if I'm coming out harsh.) |
rhettinger
changed the title
queue.rst: use 2 spaces after a period to be consistent.queue.rst: use 2 spaces after a period to be consistent.
|
Generally speaking, I wouldn't bother going through fixing more: we usually aim to avoid churn, this doesn't make any difference to end users, and the devguide says to use one or two.
|
rhettinger
changed the title
queue.rst: use 2 spaces after a period to be consistent.queue.rst: use 2 spaces after a period to be consistent.
|
(For the record, I'm not criticising you for anything, @OTheDev) |
BTW, that is a very good rule to follow for future PRs, both for code and documentation. |
|
@erlend-aasland In general, I agree that this is mostly a waste of time, but this was specifically requested by a senior core dev in another issue. |
|
@rhettinger, please do not merge PRs marked with DO-NOT-MERGE. Merging such PRs is an encouragement for churn in itself.
That request was specifically countered by three other core devs. Not exactly what I'd call consensus. |
|
I requested the original change because the PR I was responding to removed a second space, which made the style inconsistent within that file. I don't think it's a problem to restore the recently made inconsistent change, and I also don't think it's a big deal to change the other few places that file was inconsistent. |
|
Let’s just not encourage such PRs in the future. They really don’t add any value to the code base, they introduce noise in the commit history, and waste resources. Also note the prominent heading in PEP 8, https://peps.python.org/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds. |
|
Also, this now has to be backported, in order to minimise conflicts with future backports, thus creating even more churn. |
|
Thanks @OTheDev for the PR, and @rhettinger for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10. |
|
Thanks @OTheDev for the PR, and @rhettinger for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11. |
…stent. (pythonGH-102143) (cherry picked from commit 96bf243) Co-authored-by: Owain Davies <[email protected]>
|
GH-102154 is a backport of this pull request to the 3.10 branch. |
…stent. (pythonGH-102143) (cherry picked from commit 96bf243) Co-authored-by: Owain Davies <[email protected]>
|
GH-102155 is a backport of this pull request to the 3.11 branch. |
…GH-102143) (cherry picked from commit 96bf243) Co-authored-by: Owain Davies <[email protected]>
…GH-102143) (cherry picked from commit 96bf243) Co-authored-by: Owain Davies <[email protected]>
* main: (76 commits) Fix syntax error in struct doc example (python#102160) pythongh-99108: Import MD5 and SHA1 from HACL* (python#102089) pythonGH-101777: `queue.rst`: use 2 spaces after a period to be consistent. (python#102143) Few coverage nitpicks for the cmath module (python#102067) pythonGH-100982: Restrict `FOR_ITER_RANGE` to a single instruction to allow instrumentation. (pythonGH-101985) pythongh-102135: Update turtle docs to rename wikipedia demo to rosette (python#102137) pythongh-99942: python.pc on android/cygwin should link to libpython per configure.ac (pythonGH-100356) pythongh-95672 fix typo SkitTest to SkipTest (pythongh-102119) pythongh-101936: Update the default value of fp from io.StringIO to io.BytesIO (pythongh-102100) pythongh-102008: simplify test_except_star by using sys.exception() instead of sys.exc_info() (python#102009) pythongh-101903: Remove obsolete undefs for previously removed macros Py_EnterRecursiveCall and Py_LeaveRecursiveCall (python#101923) pythongh-100556: Improve clarity of `or` docs (python#100589) pythongh-101777: Make `PriorityQueue` docs slightly clearer (python#102026) pythongh-101965: Fix usage of Py_EnterRecursiveCall return value in _bisectmodule.c (pythonGH-101966) pythongh-101578: Amend exception docs (python#102057) pythongh-101961 fileinput.hookcompressed should not set the encoding value for the binary mode (pythongh-102068) pythongh-102056: Fix a few bugs in error handling of exception printing code (python#102078) pythongh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (python#102012) pythongh-101566: Sync with zipp 3.14. (pythonGH-102018) pythonGH-99818: improve the documentation for zipfile.Path and Traversable (pythonGH-101589) ...
In #102026, I put one space after a period instead of two. The latter is used throughout the file. This PR reintroduces the space that I removed.
cc @ericvsmith
EDIT: After looking a bit closer, there are other instances where a single space is used after a sentence-ending period rather than two. If desired, I can change those too.