Added comment to TextDiff

This commit is contained in:
Armin Ronacher 2021-02-03 22:51:47 +01:00
parent 05f9069769
commit 81ba51fc3c

View file

@ -163,6 +163,11 @@ impl TextDiffConfig {
/// Captures diff op codes for textual diffs.
///
/// The exact diff behavior is depending on the underlying [`DiffableStr`].
/// For instance diffs on bytes and strings are slightly different. You can
/// create a text diff from constructors such as [`TextDiff::from_lines`] or
/// the [`TextDiffConfig`] created by [`TextDiff::configure`].
///
/// Requires the `text` feature.
pub struct TextDiff<'old, 'new, 'bufs, T: DiffableStr + ?Sized> {
old: Cow<'bufs, [&'old T]>,