branch: externals/tomelr
commit 4e2edfe073d2a057a37b159d4e67282aa132f596
Author: Kaushal Modi <kaushal.m...@gmail.com>
Commit: Kaushal Modi <kaushal.m...@gmail.com>
chore: Update Commentary section of the package
Replace Authors -> Author.
---
test/all-tests.el | 2 +-
test/tarray.el | 2 +-
test/tcoerce.el | 2 +-
test/tjson-utils.el | 2 +-
test/tkey.el | 2 +-
test/tnil.el | 2 +-
test/tplist.el | 2 +-
test/tpredicates.el | 2 +-
test/tscalar.el | 2 +-
test/tstring.el | 2 +-
test/ttable-array.el | 2 +-
test/ttable.el | 2 +-
tomelr.el | 42 +++++++++++++++++++++++++++++++++++-------
13 files changed, 47 insertions(+), 19 deletions(-)
diff --git a/test/all-tests.el b/test/all-tests.el
index 503e152f3a..0c12a83826 100644
--- a/test/all-tests.el
+++ b/test/all-tests.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/tarray.el b/test/tarray.el
index 9c9088aaae..daac6c0760 100644
--- a/test/tarray.el
+++ b/test/tarray.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/tcoerce.el b/test/tcoerce.el
index c3d99a4f27..bf63910e7b 100644
--- a/test/tcoerce.el
+++ b/test/tcoerce.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/tjson-utils.el b/test/tjson-utils.el
index 6ba8091c59..bbcaaf46c0 100644
--- a/test/tjson-utils.el
+++ b/test/tjson-utils.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/tkey.el b/test/tkey.el
index 69320205ef..540c199411 100644
--- a/test/tkey.el
+++ b/test/tkey.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/tnil.el b/test/tnil.el
index 486a2fa540..217943b792 100644
--- a/test/tnil.el
+++ b/test/tnil.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/tplist.el b/test/tplist.el
index d8cbf2ee43..652ea5bb0d 100644
--- a/test/tplist.el
+++ b/test/tplist.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/tpredicates.el b/test/tpredicates.el
index f0f4e86530..cd4e70e0d0 100644
--- a/test/tpredicates.el
+++ b/test/tpredicates.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/tscalar.el b/test/tscalar.el
index 8713b636c5..918ea155c8 100644
--- a/test/tscalar.el
+++ b/test/tscalar.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/tstring.el b/test/tstring.el
index e428ffa9e6..002b5ed0df 100644
--- a/test/tstring.el
+++ b/test/tstring.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/ttable-array.el b/test/ttable-array.el
index 919763681b..a76192ede9 100644
--- a/test/ttable-array.el
+++ b/test/ttable-array.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/test/ttable.el b/test/ttable.el
index 49e96f8675..c795d36d6a 100644
--- a/test/ttable.el
+++ b/test/ttable.el
@@ -2,7 +2,7 @@
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
;; This file is not part of GNU Emacs.
diff --git a/tomelr.el b/tomelr.el
index b29e3e1022..85b962e540 100644
--- a/tomelr.el
+++ b/tomelr.el
@@ -1,12 +1,12 @@
-;;; tomelr.el --- Convert s-expressions to TOML -*- lexical-binding:
t -*-
+;;; tomelr.el --- Convert S-expressions to TOML -*- lexical-binding:
t -*-
;; Copyright (C) 2022 Free Software Foundation, Inc.
-;; Authors: Kaushal Modi <kaushal.m...@gmail.com>
-;; URL: https://github.com/kaushalmodi/tomelr
+;; Author: Kaushal Modi <kaushal.m...@gmail.com>
+;; Version: 0.2.2
;; Package-Requires: ((emacs "26.3"))
-;; Keywords: data, tools
-;; Version: 0.2.1
+;; Keywords: data, tools, toml, serialization, config
+;; URL: https://github.com/kaushalmodi/tomelr/
;; This file is not part of GNU Emacs.
@@ -25,8 +25,36 @@
;;; Commentary:
-;; tomelr.el is a library for converting Lisp data expressions to TOML
-;; (https://toml.io/en/).
+;; tomelr.el is a library for converting Lisp data expressions or
+;; S-expressions to TOML format (https://toml.io/en/).
+
+;; It has one entry point `tomelr-encode' which accepts a Lisp data
+;; expression, usually in an alist or plist form, and return a string
+;; representing the TOML serializaitno format.
+
+;; Example using an alist as input:
+;;
+;; (tomelr-encode '((title . "My title")
+;; (author . "Me")
+;; (params . ((foo . 123)))))
+;;
+;; Output:
+;;
+;; title = "My title"
+;; author = "Me"
+;; [params]
+;; foo = 123
+
+;; Example using an plist as input:
+;;
+;; (tomelr-encode '(:title "My title"
+;; :author "Me"
+;; :params (:foo 123)))
+;;
+;; Above snippet will give as the same TOML output shown above.
+
+;; See the README.org on https://github.com/kaushalmodi/tomelr/ for
+;; more examples and package details.
;;; Code:
