emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/reformatter 78eb8bc98a 09/81: Doc clarifications


From: ELPA Syncer
Subject: [nongnu] elpa/reformatter 78eb8bc98a 09/81: Doc clarifications
Date: Tue, 5 Sep 2023 04:03:32 -0400 (EDT)

branch: elpa/reformatter
commit 78eb8bc98ac49be1b2de2be3028e6a24a706fc20
Author: Steve Purcell <steve@sanityinc.com>
Commit: Steve Purcell <steve@sanityinc.com>

    Doc clarifications
---
 README.md      | 5 ++++-
 reformatter.el | 6 +++++-
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5bc7817490..78a98c247b 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,10 @@ dhall executable:
 
 The `reformatter-define` macro expands to code which generates both
 the `dhall-format` interactive command and a local minor mode called
-`dhall-format-on-save-mode`.
+`dhall-format-on-save-mode`. The `:args` and `:program` expressions
+will be evaluated at runtime, so they can refer to variables that may
+(later) have a buffer-local value. A custom variable will be generated
+for the mode lighter, with the supplied value becoming the default.
 
 The generated minor mode allows idiomatic per-directory or per-file
 customisation, via the "modes" support baked into Emacs' file-local
diff --git a/reformatter.el b/reformatter.el
index 3146bad41f..b78d4538cb 100644
--- a/reformatter.el
+++ b/reformatter.el
@@ -43,7 +43,11 @@
 
 ;; The `reformatter-define' macro expands to code which generates both
 ;; the `dhall-format' interactive command and a local minor mode
-;; called `dhall-format-on-save-mode'
+;; called `dhall-format-on-save-mode'.  The :args" and :program
+;; expressions will be evaluated at runtime, so they can refer to
+;; variables that may (later) have a buffer-local value.  A custom
+;; variable will be generated for the mode lighter, with the supplied
+;; value becoming the default.
 
 ;; The generated minor mode allows idiomatic per-directory or per-file
 ;; customisation, via the "modes" support baked into Emacs' file-local



reply via email to

[Prev in Thread] Current Thread [Next in Thread]