diff options
| author | Geoffrey Thomas <geofft@ldpreload.com> | 2024-05-22 16:35:18 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-22 16:35:18 (GMT) |
| commit | ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b (patch) | |
| tree | 22da7f25285e842c48daf81b0ae2a57e223cc674 /Lib/heapq.py | |
| parent | 81865002aee8eaaeb3c7e402f86183afa6de77bf (diff) | |
| download | cpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.zip cpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.tar.gz cpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.tar.bz2 | |
Remove almost all unpaired backticks in docstrings (#119231)
As reported in #117847 and #115366, an unpaired backtick in a docstring
tends to confuse e.g. Sphinx running on subclasses of standard library
objects, and the typographic style of using a backtick as an opening
quote is no longer in favor. Convert almost all uses of the form
The variable `foo' should do xyz
to
The variable 'foo' should do xyz
and also fix up miscellaneous other unpaired backticks (extraneous /
missing characters).
No functional change is intended here other than in human-readable
docstrings.
Diffstat (limited to 'Lib/heapq.py')
| -rw-r--r-- | Lib/heapq.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Lib/heapq.py b/Lib/heapq.py index 2fd9d1f..c53cb55 100644 --- a/Lib/heapq.py +++ b/Lib/heapq.py @@ -42,7 +42,7 @@ non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element. The strange invariant above is meant to be an efficient memory -representation for a tournament. The numbers below are `k', not a[k]: +representation for a tournament. The numbers below are 'k', not a[k]: 0 @@ -55,7 +55,7 @@ representation for a tournament. The numbers below are `k', not a[k]: 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 -In the tree above, each cell `k' is topping `2*k+1' and `2*k+2'. In +In the tree above, each cell 'k' is topping '2*k+1' and '2*k+2'. In a usual binary tournament we see in sports, each cell is the winner over the two cells it tops, and we can trace the winner down the tree to see all opponents s/he had. However, in many computer applications @@ -110,7 +110,7 @@ vanishes, you switch heaps and start a new run. Clever and quite effective! In a word, heaps are useful memory structures to know. I use them in -a few applications, and I think it is good to keep a `heap' module +a few applications, and I think it is good to keep a 'heap' module around. :-) -------------------- |