Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 2ee8099

Browse files
committed
HtmlDiff corrections from Dan Gass, + trimmed trailing whitespace.
1 parent d60e92a commit 2ee8099

1 file changed

Lines changed: 32 additions & 29 deletions

File tree

Doc/lib/libdifflib.tex

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ \section{\module{difflib} ---
5656

5757
This class can be used to create an HTML table (or a complete HTML file
5858
containing the table) showing a side by side, line by line comparison
59-
of text with inter-line and intra-line change highlights. The table can
59+
of text with inter-line and intra-line change highlights. The table can
6060
be generated in either full or contextual difference mode.
6161

6262
The constructor for this class is:
@@ -67,20 +67,21 @@ \section{\module{difflib} ---
6767
\optional{, linejunk
6868
\optional{, charjunk}}}}}
6969

70-
Initializes instance of \class{HtmlDiff}.
70+
Initializes instance of \class{HtmlDiff}.
7171

72-
\var{tabsize} is an optional keyword argument to specify tab stop spacing
72+
\var{tabsize} is an optional keyword argument to specify tab stop spacing
7373
and defaults to \code{8}.
7474

75-
\var{wrapcolumn} is an optional keyword to specify column number where
76-
lines are broken and wrapped, defaults to \code{None} where lines are not
75+
\var{wrapcolumn} is an optional keyword to specify column number where
76+
lines are broken and wrapped, defaults to \code{None} where lines are not
7777
wrapped.
7878

79-
\var{linejunk} and \var{charjunk} are optional keyword arguments passed
80-
into \code{ndiff()} (used to by \class{HtmlDiff} to generate the
81-
side by side HTML differences). See \code{ndiff()} documentation for
79+
\var{linejunk} and \var{charjunk} are optional keyword arguments passed
80+
into \code{ndiff()} (used by \class{HtmlDiff} to generate the
81+
side by side HTML differences). See \code{ndiff()} documentation for
8282
argument default values and descriptions.
83-
\end{funcdesc}
83+
84+
\end{funcdesc}
8485

8586
The following methods are public:
8687

@@ -92,21 +93,21 @@ \section{\module{difflib} ---
9293
Compares \var{fromlines} and \var{tolines} (lists of strings) and returns
9394
a string which is a complete HTML file containing a table showing line by
9495
line differences with inter-line and intra-line changes highlighted.
95-
96-
\var{fromdesc} and \var{todesc} are optional keyword arguments to specify
97-
from/to file column header strings (both default to an empty string).
98-
96+
97+
\var{fromdesc} and \var{todesc} are optional keyword arguments to specify
98+
from/to file column header strings (both default to an empty string).
99+
99100
\var{context} and \var{numlines} are both optional keyword arguments.
100-
Set \var{context} to \code{True} when contextual differences are to be
101-
shown, else the default is \code{False} to show the full files.
101+
Set \var{context} to \code{True} when contextual differences are to be
102+
shown, else the default is \code{False} to show the full files.
102103
\var{numlines} defaults to \code{5}. When \var{context} is \code{True}
103-
\var{numlines} controls the number of context lines which surround the
104+
\var{numlines} controls the number of context lines which surround the
104105
difference highlights. When \var{context} is \code{False} \var{numlines}
105-
controls the number of lines which are shown before a difference
106+
controls the number of lines which are shown before a difference
106107
highlight when using the "next" hyperlinks (setting to zero would cause
107108
the "next" hyperlinks to place the next difference highlight at the top of
108109
the browser without any leading context).
109-
\end{funcdesc}
110+
\end{funcdesc}
110111

111112
\begin{funcdesc}{make_table}{fromlines, tolines
112113
\optional{, fromdesc
@@ -115,14 +116,16 @@ \section{\module{difflib} ---
115116
Compares \var{fromlines} and \var{tolines} (lists of strings) and returns
116117
a string which is a complete HTML table showing line by line differences
117118
with inter-line and intra-line changes highlighted.
118-
119-
The arguments of this method are a subset of those for the
120-
\code{make_file} method. Refer to the \code{make_file} method
119+
120+
The arguments of this method are a subset of those for the
121+
\code{make_file} method. Refer to the \code{make_file} method
121122
documentation.
122-
\end{funcdesc}
123+
\end{funcdesc}
123124

124-
\file{Tools/scripts/ndiff.py} is a command-line front-end to this class
125+
\file{Tools/scripts/diff.py} is a command-line front-end to this class
125126
and contains a good example of its use.
127+
128+
\versionadded{2.4}
126129
\end{classdesc*}
127130

128131
\begin{funcdesc}{context_diff}{a, b\optional{, fromfile\optional{, tofile
@@ -131,7 +134,7 @@ \section{\module{difflib} ---
131134
Compare \var{a} and \var{b} (lists of strings); return a
132135
delta (a generator generating the delta lines) in context diff
133136
format.
134-
137+
135138
Context diffs are a compact way of showing just the lines that have
136139
changed plus a few lines of context. The changes are shown in a
137140
before/after style. The number of context lines is set by \var{n}
@@ -156,7 +159,7 @@ \section{\module{difflib} ---
156159
function.
157160

158161
\versionadded{2.3}
159-
\end{funcdesc}
162+
\end{funcdesc}
160163

161164
\begin{funcdesc}{get_close_matches}{word, possibilities\optional{,
162165
n\optional{, cutoff}}}
@@ -263,7 +266,7 @@ \section{\module{difflib} ---
263266
Compare \var{a} and \var{b} (lists of strings); return a
264267
delta (a generator generating the delta lines) in unified diff
265268
format.
266-
269+
267270
Unified diffs are a compact way of showing just the lines that have
268271
changed plus a few lines of context. The changes are shown in a
269272
inline style (instead of separate before/after blocks). The number
@@ -287,8 +290,8 @@ \section{\module{difflib} ---
287290
\file{Tools/scripts/diff.py} is a command-line front-end for this
288291
function.
289292

290-
\versionadded{2.3}
291-
\end{funcdesc}
293+
\versionadded{2.3}
294+
\end{funcdesc}
292295

293296
\begin{funcdesc}{IS_LINE_JUNK}{line}
294297
Return true for ignorable lines. The line \var{line} is ignorable
@@ -481,7 +484,7 @@ \subsection{SequenceMatcher Objects \label{sequence-matcher}}
481484
intervening ranges which have no changes.
482485

483486
The groups are returned in the same format as \method{get_opcodes()}.
484-
\versionadded{2.3}
487+
\versionadded{2.3}
485488
\end{methoddesc}
486489

487490
\begin{methoddesc}{ratio}{}

0 commit comments

Comments
 (0)