branch: elpa/racket-mode
commit 7b4b77cd4ef9746538ad0bd386bebfe57a0043db
Author: Greg Hendershott <g...@greghendershott.com>
Commit: Greg Hendershott <g...@greghendershott.com>
Update doc string prose for racket-mode and racket-hash-lang-mode
---
doc/racket-mode.org | 2 +-
doc/racket-mode.texi | 18 +++++++++++++-----
racket-hash-lang.el | 7 ++++---
racket-mode.el | 11 ++++++++++-
4 files changed, 28 insertions(+), 10 deletions(-)
diff --git a/doc/racket-mode.org b/doc/racket-mode.org
index 16e2488a8c..a54b465c12 100644
--- a/doc/racket-mode.org
+++ b/doc/racket-mode.org
@@ -183,7 +183,7 @@ You can use different major modes for different kinds of
files:
- For editing ~.rkt~ files and s-expression langs, which mode to use is
personal preference.
-- For ~.scrbl~ and at-expression langs like ~scribble/manual~,
~racket-hash-lang-mode~ is probably better than ~racket-mode~. (Note there is
also an unrelated ~scribble-mode~ package.)
+- For ~.scrbl~ files and at-expression langs like ~scribble/manual~,
~racket-hash-lang-mode~ is probably better than ~racket-mode~. (Note there is
also an unrelated ~scribble-mode~ package.)
- For non-s-expression langs like ~datalog~ or ~rhombus~ (~.rhm~),
~racket-hash-lang-mode~ is definitely better than ~racket-mode~. (Note there is
also an unrelated ~rhombus-mode~ package.)
diff --git a/doc/racket-mode.texi b/doc/racket-mode.texi
index ad8d19360e..01b562da53 100644
--- a/doc/racket-mode.texi
+++ b/doc/racket-mode.texi
@@ -597,7 +597,7 @@ You can use different major modes for different kinds of
files:
For editing @code{.rkt} files and s-expression langs, which mode to use is
personal preference.
@item
-For @code{.scrbl} and at-expression langs like @code{scribble/manual},
@code{racket-hash-lang-mode} is probably better than @code{racket-mode}. (Note
there is also an unrelated @code{scribble-mode} package.)
+For @code{.scrbl} files and at-expression langs like @code{scribble/manual},
@code{racket-hash-lang-mode} is probably better than @code{racket-mode}. (Note
there is also an unrelated @code{scribble-mode} package.)
@item
For non-s-expression langs like @code{datalog} or @code{rhombus}
(@code{.rhm}), @code{racket-hash-lang-mode} is definitely better than
@code{racket-mode}. (Note there is also an unrelated @code{rhombus-mode}
package.)
@@ -970,7 +970,14 @@ You can also view these by using the normal Emacs help
mechanism:
@kbd{M-x} @code{racket-mode}
-Major mode for editing Racket source files.
+The ``classic'' major mode to edit an s-expression Racket #lang.
+
+This major mode is implemented entirely in Emacs and does @emph{not}
+need Racket Mode's back end racket process to be running.
+Font-lock (coloring) uses rules for a fixed set of identifiers
+from @code{racket} lang and popular modules like @code{racket/match}.
+Indentation uses rules for a fixed set of forms, and may be
+customized.
@multitable
{aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
{aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@item Key
@@ -1554,10 +1561,11 @@ completion candidates, enable the minor mode
@ref{racket-xp-mode}.
@kbd{M-x} @code{racket-hash-lang-mode}
-Use color-lexer, indent, and navigation supplied by a #lang.
+An ``experimental'' major mode to edit any Racket #lang.
-An experimental major mode alternative to @ref{racket-mode} for
-source file edit buffers.
+This major mode uses color-lexer, indent, and navigation supplied
+by each #lang -- which means Racket Mode's back end process needs
+to be running.
In your Emacs configuration, you may want to update the
variable @code{auto-mode-alist} to use @ref{racket-hash-lang-mode} for
diff --git a/racket-hash-lang.el b/racket-hash-lang.el
index 916f1f5c76..7e12ba10ff 100644
--- a/racket-hash-lang.el
+++ b/racket-hash-lang.el
@@ -235,10 +235,11 @@ in English.")
;;;###autoload
(define-derived-mode racket-hash-lang-mode prog-mode
'racket-hash-lang-mode-lighter
- "Use color-lexer, indent, and navigation supplied by a #lang.
+ "An \"experimental\" major mode to edit any Racket #lang.
-An experimental major mode alternative to `racket-mode' for
-source file edit buffers.
+This major mode uses color-lexer, indent, and navigation supplied
+by each #lang -- which means Racket Mode's back end process needs
+to be running.
In your Emacs configuration, you may want to update the
variable `auto-mode-alist' to use `racket-hash-lang-mode' for
diff --git a/racket-mode.el b/racket-mode.el
index eea3d20f19..250da6c726 100644
--- a/racket-mode.el
+++ b/racket-mode.el
@@ -132,7 +132,16 @@
;;;###autoload
(define-derived-mode racket-mode prog-mode
"Racket"
- "Major mode for editing Racket source files.
+ "The \"classic\" major mode to edit an s-expression Racket #lang.
+
+This major mode is implemented entirely in Emacs and does /not/
+need Racket Mode's back end racket process to be running.
+Font-lock (coloring) uses rules for a fixed set of identifiers
+from ~racket~ lang and popular modules like ~racket/match~.
+Indentation uses rules for a fixed set of forms, and may be
+customized.
+
+See also `racket-hash-lang-mode'.
\\{racket-mode-map}"
(racket--polite-user-f-keys racket-mode-map racket--f5-bindings)
