49 Commits

Author SHA1 Message Date
Serhiy Storchaka
d360346640 [3.8] bpo-38738: Fix formatting of True and False. (GH-17083) (GH-17125)
* "Return true/false" is replaced with "Return ``True``/``False``"
  if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
(cherry picked from commit 138ccbb022)
2019-11-12 18:54:10 +02:00
Miss Islington (bot)
44e36e8045 bpo-35603: Add a note on difflib table header interpreted as HTML (GH-11439)
(cherry picked from commit c78dae8d2b)

Co-authored-by: Xtreak <tir.karthi@gmail.com>
2019-09-11 05:24:55 -07:00
Miss Islington (bot)
1a3a40c1cb bpo-37004: Documented asymmetry of string arguments in difflib.SequenceMatcher for ratio method (GH-13482) (#15157)
https://bugs.python.org/issue37004
(cherry picked from commit e9cbcd0018)

Co-authored-by: sweeneyde <36520290+sweeneyde@users.noreply.github.com>
2019-08-07 11:39:14 -04:00
Terry Jan Reedy
d9bff4e81b bpo-35079: Revise difflib.SequenceManager.get_matching_blocks doc (GH-10144)
Specify that blocks are non-overlapping. Change '!=' to '<'.
2018-10-26 23:03:08 -04:00
Zachary Ware
9f8b3a0b92 Issue #27210: Fix doctests for a few modules.
Initial patch by Jelle Zijlstra.
2016-08-10 00:59:59 -05:00
Terry Jan Reedy
fa089b9b0b Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Serhiy Storchaka
6dff0205b7 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:49:07 +03:00
Berker Peksag
eb2e02bed4 Issue #26542: Fix markup of code example in difflib documentation
Patch by Dmitry Shachnev.
2016-03-11 23:19:48 +02:00
Martin Panter
2eb819f7a8 Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5 2015-11-02 04:04:57 +00:00
Martin Panter
7462b64911 Issue #25523: Correct "a" article to "an" article
This changes the main documentation, doc strings, source code comments, and a
couple error messages in the test suite. In some cases the word was removed
or edited some other way to fix the grammar.
2015-11-02 03:37:02 +00:00
Terry Jan Reedy
c02948126c Merge with 3.4 2015-10-30 19:41:28 -04:00
Terry Jan Reedy
3e8a7ad7fc Issue #25519: Mark difflib.ndiff as a functions where not already. 2015-10-30 19:41:16 -04:00
Berker Peksag
707deb9df4 Issue #24109: Include Tools/scripts/diff.py instead of duplicating it in difflib documentation.
Patch by Keith Gray.
2015-07-30 00:03:48 +03:00
Greg Ward
4d9d2563f5 #17445: difflib: add diff_bytes(), to compare bytes rather than str
Some applications (e.g. traditional Unix diff, version control
systems) neither know nor care about the encodings of the files they
are comparing. They are textual, but to the diff utility they are just
bytes. This worked fine under Python 2, because all of the hardcoded
strings in difflib.py are ASCII, so could safely be combined with
old-style u'' strings. But it stopped working in 3.x.

The solution is to use surrogate escapes for a lossless
bytes->str->bytes roundtrip. That means {unified,context}_diff() can
continue to just handle strings without worrying about bytes. Callers
who have to deal with bytes will need to change to using diff_bytes().

Use case: Mercurial's test runner uses difflib to compare current hg
output with known good output. But Mercurial's output is just bytes,
since it can contain:
  * file contents (arbitrary unknown encoding)
  * filenames (arbitrary unknown encoding)
  * usernames and commit messages (usually UTF-8, but not guaranteed
    because old versions of Mercurial did not enforce it)
  * user messages (locale encoding)

Since the output of any given hg command can include text in multiple
encodings, it is hopeless to try to treat it as decodable Unicode
text. It's just bytes, all the way down.

This is an elaboration of a patch by Terry Reedy.
2015-04-20 20:21:21 -04:00
Berker Peksag
102029dfd6 Issue #2052: Add charset parameter to HtmlDiff.make_file(). 2015-03-15 01:18:47 +02:00
Georg Brandl
794e9bf1fe merge with 3.4 2014-10-29 10:27:06 +01:00
Georg Brandl
525d355984 Fixing broken links in doc, part 3: the rest 2014-10-29 10:26:56 +01:00
Terry Jan Reedy
386b2b18f5 Merge with 3.4. Closes #21232. 2014-04-18 17:00:50 -04:00
Terry Jan Reedy
bddecc3861 Issue #21232: Replace .splitlines arg '1' with 'keepends=True'. 2014-04-18 17:00:19 -04:00
Andrew Kuchling
c51da2b8a0 #14332: provide a better explanation of junk in difflib docs
Initial patch by Alba Magallanes.
2014-03-19 16:43:06 -04:00
Andrew Kuchling
2e3743cd30 #13437: link to the source code for a few more modules 2014-03-19 16:23:01 -04:00
Serhiy Storchaka
fbc1c26803 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:17:13 +02:00
Serhiy Storchaka
bfdcd436f0 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:09:14 +03:00
R David Murray
96433f8e34 #18601: fix error made when difflib example was converted to use 'with'. 2013-07-30 15:37:11 -04:00
Raymond Hettinger
1929983518 Beautify and modernize the SequenceMatcher example 2011-04-09 19:41:31 -07:00