Skip to content

Instantly share code, notes, and snippets.

@tealtan
Last active August 29, 2015 14:05
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save tealtan/8533e7491fa36451ce21 to your computer and use it in GitHub Desktop.
Save tealtan/8533e7491fa36451ce21 to your computer and use it in GitHub Desktop.
Guidelines Behind Prose Diffs
  • The units of meaning is not the "line", but the word, sentence, paragraph, section.
  • Editing a word/sentence/paragraph/section is different than moving it elsewhere.
  • If a sentence or paragraph or section changed, you would want to show which specific parts of it changed, instead of highlighting the entire larger unit.
  • It would likely be helpful to show the change in context, possibly as a before/after toggle.
  • Markup would be very difficult to parse. (Open/close tags across sentences, etc.) But markdown would be all right.
  • There are trivial changes, meaningful changes, and then meaningful changes that you want to call out.
  • Adding line breaks don’t matter, unless it forms a new paragraph.
@aredridel
Copy link

Yes, exactly this!

Markup is QUITE a pain.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment