From 99a57bbbdff938891b0365837595002c59fc3939 Mon Sep 17 00:00:00 2001 From: Wilfred Hughes Date: Sun, 27 Aug 2017 13:00:01 +0100 Subject: Show a comparison of docstring rendering --- README.md | 11 +++++++---- screenshots/helpful_compare.png | Bin 0 -> 75696 bytes 2 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 screenshots/helpful_compare.png diff --git a/README.md b/README.md index 48db6d2..7e2b173 100644 --- 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 new file mode 100644 index 0000000..b57706b Binary files /dev/null and b/screenshots/helpful_compare.png differ -- cgit v1.0