mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

[3.12] gh-101100: Fix sphinx warnings in library/difflib.rst (GH-110074) (#110081)

Browse source 
gh-101100: Fix sphinx warnings in `library/difflib.rst` (GH-110074)
(cherry picked from commit d102d39bbe)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
This commit is contained in:
Miss Islington (bot) 2023-09-29 06:29:14 -07:00 • committed by GitHub
parent 69a9f47125
commit 297104cce5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/library/difflib.rst
View file

@ -570,8 +570,8 @@ The :class:`SequenceMatcher` class has this constructor:
The three methods that return the ratio of matching to total characters can give The three methods that return the ratio of matching to total characters can give
different results due to differing levels of approximation, although different results due to differing levels of approximation, although
:meth:`quick_ratio` and :meth:`real_quick_ratio` are always at least as large as :meth:`~SequenceMatcher.quick_ratio` and :meth:`~SequenceMatcher.real_quick_ratio`
:meth:`ratio`: are always at least as large as :meth:`~SequenceMatcher.ratio`:
>>> s = SequenceMatcher(None, "abcd", "bcde") >>> s = SequenceMatcher(None, "abcd", "bcde")
>>> s.ratio() >>> s.ratio()
@ -593,15 +593,15 @@ This example compares two strings, considering blanks to be "junk":
... "private Thread currentThread;", ... "private Thread currentThread;",
... "private volatile Thread currentThread;") ... "private volatile Thread currentThread;")
:meth:`ratio` returns a float in [0, 1], measuring the similarity of the :meth:`~SequenceMatcher.ratio` returns a float in [0, 1], measuring the similarity of the
sequences. As a rule of thumb, a :meth:`ratio` value over 0.6 means the sequences. As a rule of thumb, a :meth:`~SequenceMatcher.ratio` value over 0.6 means the
sequences are close matches: sequences are close matches:
>>> print(round(s.ratio(), 3)) >>> print(round(s.ratio(), 3))
0.866 0.866
If you're only interested in where the sequences match, If you're only interested in where the sequences match,
:meth:`get_matching_blocks` is handy: :meth:`~SequenceMatcher.get_matching_blocks` is handy:
>>> for block in s.get_matching_blocks(): >>> for block in s.get_matching_blocks():
... print("a[%d] and b[%d] match for %d elements" % block) ... print("a[%d] and b[%d] match for %d elements" % block)
@ -609,12 +609,12 @@ If you're only interested in where the sequences match,
a[8] and b[17] match for 21 elements a[8] and b[17] match for 21 elements
a[29] and b[38] match for 0 elements a[29] and b[38] match for 0 elements
Note that the last tuple returned by :meth:`get_matching_blocks` is always a Note that the last tuple returned by :meth:`~SequenceMatcher.get_matching_blocks`
dummy, ``(len(a), len(b), 0)``, and this is the only case in which the last is always a dummy, ``(len(a), len(b), 0)``, and this is the only case in which the last
tuple element (number of elements matched) is ``0``. tuple element (number of elements matched) is ``0``.
If you want to know how to change the first sequence into the second, use If you want to know how to change the first sequence into the second, use
:meth:`get_opcodes`: :meth:`~SequenceMatcher.get_opcodes`:
>>> for opcode in s.get_opcodes(): >>> for opcode in s.get_opcodes():
... print("%6s a[%d:%d] b[%d:%d]" % opcode) ... print("%6s a[%d:%d] b[%d:%d]" % opcode)
@ -689,7 +689,7 @@ Differ Example
This example compares two texts. First we set up the texts, sequences of This example compares two texts. First we set up the texts, sequences of
individual single-line strings ending with newlines (such sequences can also be individual single-line strings ending with newlines (such sequences can also be
obtained from the :meth:`~io.BaseIO.readlines` method of file-like objects): obtained from the :meth:`~io.IOBase.readlines` method of file-like objects):
>>> text1 = ''' 1. Beautiful is better than ugly. >>> text1 = ''' 1. Beautiful is better than ugly.
... 2. Explicit is better than implicit. ... 2. Explicit is better than implicit.

1
Doc/tools/.nitignore
View file

@ -60,7 +60,6 @@ Doc/library/csv.rst
Doc/library/datetime.rst Doc/library/datetime.rst
Doc/library/dbm.rst Doc/library/dbm.rst
Doc/library/decimal.rst Doc/library/decimal.rst
Doc/library/difflib.rst
Doc/library/doctest.rst Doc/library/doctest.rst
Doc/library/email.charset.rst Doc/library/email.charset.rst
Doc/library/email.compat32-message.rst Doc/library/email.compat32-message.rst