branch: elpa/parseedn
commit 8f0582da3f1dbce24e93aee7ca26eefea6053f43
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Improve the commentary front matter
---
parseedn.el | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/parseedn.el b/parseedn.el
index 95e6003745..7b09f598c6 100644
--- a/parseedn.el
+++ b/parseedn.el
@@ -26,7 +26,16 @@
;;; Commentary:
-;; The EDN <-> Elisp reader and printer
+;; parseedn is an Emacs Lisp library for parsing EDN (Clojure) data.
+;; It uses parseclj's shift-reduce parser internally.
+
+;; EDN and Emacs Lisp have some important differences that make
+;; translation from one to the other not transparent (think
+;; representing an EDN map into Elisp, or being able to differentiate
+;; between false and nil in Elisp). Because of this, parseedn takes
+;; certain decisions when parsing and transforming EDN data into Elisp
+;; data types. For more information please refer to parseclj's design
+;; documentation.
;;; Code:
