helpful

commit 99a57bbbdff938891b0365837595002c59fc3939
parent aeeaa7aaf47253c891c569085eeb723a4aeb01f0
Author: Wilfred Hughes <me@wilfred.me.uk>
Date:   Sun, 27 Aug 2017 13:00:01 +0100

Show a comparison of docstring rendering

Diffstat:
M
README.md
 | 
11
+++++++----
A
screenshots/helpful_compare.png
 | 
0

2 files changed, 7 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -21,12 +21,15 @@ Help) and falls back to the raw sexp if no source is available.
 
 Helpful will show you where a function is being called!
 
-### Pretty Docstrings
+### Prettier Docstrings
 
-![screenshot](screenshots/helpful_docs.png)
+![screenshot](screenshots/helpful_compare.png)
 
-Helpful renders docstrings with full cross-references, hiding
-superfluous punctuation.
+Docstrings in helpful:
+
+* Highlight the summary (the first sentence)
+* Include cross-references
+* Hide superfluous puncuation
 
 ### Symbol Properties
 
diff --git a/screenshots/helpful_compare.png b/screenshots/helpful_compare.png
Binary files differ.