[elpa] master e321c3d 09/22: Improve clarity of some docs

[Stefan Monnier]

branch: master
commit e321c3d6a7db3ce74e6b9dae565b66f6354b89a6
Author: Mitchel Humpherys <address@hidden>
Commit: Mitchel Humpherys <address@hidden>

    Improve clarity of some docs
    
    I can haz understand you?
---
 README.md   |   17 ++++++++++-------
 diffview.el |   17 ++++++++++-------
 2 files changed, 20 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 59fc3a2..1e8851d 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@
 ---
 [![License 
GPL3](https://img.shields.io/badge/license-GPL_3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.html)
 
-Take a plain ol' diff and view it in an easier-to-comprehend
-side-by-side format. This comes in handy for ready patches from
-mailing lists (or from whencever you might acquire them).
+Render a unified diff (top/bottom) in an easy-to-comprehend side-by-side
+format. This comes in handy for reading patches from mailing lists (or
+from whencever you might acquire them).
 
 ### Installation
 
@@ -15,14 +15,17 @@ Put this file on your load-path and do:
 
     (require 'diffview)
 
+(MELPA installation coming soon...)
+
 ### Usage
 
 
-The following functions are provided:
+The following functions are provided for launching a side-by-side diff:
 
-* `diffview-current` : Opens the current buffer with `diffview`
-* `diffview-region` : Opens the current region with `diffview`
-* `diffview-message` : Opens the current email message with `diffview`
+* `diffview-current` : View the current diff buffer side-by-side
+* `diffview-region` : View the current diff region side-by-side
+* `diffview-message` : View the current email message (which presumably
+   contains a patch) side-by-side
 
 
 ### Screenshots
diff --git a/diffview.el b/diffview.el
index 45e421f..9e149da 100644
--- a/diffview.el
+++ b/diffview.el
@@ -23,9 +23,9 @@
 ;;; Commentary:
 ;; [![License 
GPL3](https://img.shields.io/badge/license-GPL_3-green.svg)](http://www.gnu.org/licenses/gpl-3.0.html)
 ;;
-;; Take a plain ol' diff and view it in an easier-to-comprehend
-;; side-by-side format. This comes in handy for ready patches from
-;; mailing lists (or from whencever you might acquire them).
+;; Render a unified diff (top/bottom) in an easy-to-comprehend side-by-side
+;; format. This comes in handy for reading patches from mailing lists (or
+;; from whencever you might acquire them).
 ;;
 ;;; Installation:
 ;;
@@ -33,13 +33,16 @@
 ;;
 ;;     (require 'diffview)
 ;;
+;; (MELPA installation coming soon...)
+;;
 ;;; Usage:
 ;;
-;; The following functions are provided:
+;; The following functions are provided for launching a side-by-side diff:
 ;;
-;; o `diffview-current` : Opens the current buffer with `diffview`
-;; o `diffview-region` : Opens the current region with `diffview`
-;; o `diffview-message` : Opens the current email message with `diffview`
+;; o `diffview-current` : View the current diff buffer side-by-side
+;; o `diffview-region` : View the current diff region side-by-side
+;; o `diffview-message` : View the current email message (which presumably
+;;    contains a patch) side-by-side
 ;;
 ;;
 ;;; Screenshots: