branch: elpa/haskell-ts-mode
commit 1162459e4a0ad182394f6e359bcc61c006084645
Author: Pranshu Sharma <pranshu@pebl>
Commit: Pranshu Sharma <pranshu@pebl>
Readme update
Added some extra documentation about prettify symbols, etc...
---
README.org | 12 +++++++++---
haskell-ts-mode.el | 2 +-
2 files changed, 10 insertions(+), 4 deletions(-)
diff --git a/README.org b/README.org
index 4cc715d748..5b46f0aaf5 100644
--- a/README.org
+++ b/README.org
@@ -16,7 +16,7 @@ The above screenshot is indented and coloured using
=haskell-ts-mode=, with
- =C-c C-r= Open REPL
- =C-c C-c= Send code to REPL
-- =C-M-q= Indent the function
+- =M-q= Indent the function
* Features
@@ -77,8 +77,8 @@ the end of the second line.
* Installation
-The package is avaiable on
[[https://elpa.nongnu.org/nongnu/haskell-ts-mode.html][NonGnu ELPA]], you can
install it using:
-: M-x package-install RET haskell-ts-mode RET
+The package is avaiable on
[[https://elpa.nongnu.org/nongnu/haskell-ts-mode.html][NonGnu ELPA]], you can
install it using: ~M-x
+package-install RET haskell-ts-mode RET~
#+begin_src elisp
(add-to-list 'load-path "path/to/haskell-ts-mode")
@@ -119,6 +119,12 @@ To add =eglot= support, add the following code to your
=init.el=:
'(haskell-ts-mode . ("haskell-language-server-wrapper"
"--lsp"))))
#+end_src
+** Prettify sybmols mode
+
+Turning on =prettify-symbols-mode= does stuff like turn ~->~ to ~→~. If you
+want to prettify words, set =haskell-ts-prettify-words= to non-nil.
+This will do stuff like prettify ~forall~ into ~∀~ and ~elem~ to ~∈~.
+
* TODO
- Imenu support for functions with multiple definitions.
- _Proper indenting of multiline signatures_: the Tree-sitter grammar
diff --git a/haskell-ts-mode.el b/haskell-ts-mode.el
index e24a4bde27..1253c21fa3 100644
--- a/haskell-ts-mode.el
+++ b/haskell-ts-mode.el
@@ -67,7 +67,7 @@
(defcustom haskell-ts-prettify-words nil
"Prettify some words to unicode symbols.
-This will concat `haskell-ts-prettify-symbols-words' to
+This will concat `haskell-ts-prettify-words-alist' to
`prettify-symbols-alist' in `haskell-ts-mode'."
:type 'boolean)
