diff options
| author | Wilfred Hughes <me@wilfred.me.uk> | 2017-08-27 13:00:01 +0100 |
|---|---|---|
| committer | Wilfred Hughes <me@wilfred.me.uk> | 2017-08-27 13:00:01 +0100 |
| commit | 99a57bbbdff938891b0365837595002c59fc3939 (patch) | |
| tree | 7aae011144c1ab2f8180498fa39336c340e389c8 | |
| parent | aeeaa7aaf47253c891c569085eeb723a4aeb01f0 (diff) | |
Show a comparison of docstring rendering
| -rw-r--r-- | README.md | 11 | ||||
| -rw-r--r-- | screenshots/helpful_compare.png | bin | 0 -> 75696 bytes |
2 files changed, 7 insertions, 4 deletions
@@ -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 - + -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 differnew file mode 100644 index 0000000..b57706b --- /dev/null +++ b/screenshots/helpful_compare.png |
