]> git.eshelyaron.com Git - emacs.git/commitdiff
Document ispell comment/string checking commands in the user manual
authorŠtěpán Němec <stepnem@gmail.com>
Thu, 9 Apr 2020 14:17:57 +0000 (16:17 +0200)
committerŠtěpán Němec <stepnem@gmail.com>
Wed, 26 Aug 2020 11:19:46 +0000 (13:19 +0200)
* doc/emacs/fixit.texi (Spelling): Mention
'ispell-comments-and-strings' and 'ispell-comment-or-string-at-point'.
(bug#6411)

doc/emacs/fixit.texi
etc/NEWS

index 6633848716ebe9ef6cfc00b4605b595bc16e888e..db77ae4ec26890ae7d327decc96e03602f9ed176 100644 (file)
@@ -277,6 +277,10 @@ Check and correct spelling in the region.
 @item M-x ispell-message
 Check and correct spelling in a draft mail message, excluding cited
 material.
+@item M-x ispell-comments-and-strings
+Check and correct spelling of comments and strings in the buffer or region.
+@item M-x ispell-comment-or-string-at-point
+Check the comment or string at point.
 @item M-x ispell-change-dictionary @key{RET} @var{dict} @key{RET}
 Restart the spell-checker process, using @var{dict} as the dictionary.
 @item M-x ispell-kill-ispell
@@ -304,6 +308,8 @@ region; @pxref{Disabled Transient Mark}.)
 @findex ispell
 @findex ispell-buffer
 @findex ispell-region
+@findex ispell-comments-and-strings
+@findex ispell-comment-or-string-at-point
 @cindex spell-checking the active region
   Similarly, the command @kbd{M-x ispell} performs spell-checking in
 the region if one is active, or in the entire buffer otherwise.  The
@@ -312,7 +318,10 @@ explicitly perform spell-checking on the entire buffer or the region
 respectively.  To check spelling in an email message you are writing,
 use @w{@kbd{M-x ispell-message}}; that command checks the whole buffer,
 except for material that is indented or appears to be cited from other
-messages.  @xref{Sending Mail}.
+messages.  @xref{Sending Mail}.  When dealing with source code, you
+can use @kbd{M-x ispell-comments-and-strings} or @w{@kbd{M-x
+ispell-comment-or-string-at-point}} to check only comments or string
+literals.
 
   When one of these commands encounters what appears to be an
 incorrect word, it asks you what to do.  It usually displays a list of
index 05105a1e68e23901cbb33a160a43c6f384e808e7..5cb6fcb9345a29bdc81753ed792c834038ab5247 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -383,11 +383,11 @@ The menu-bar Help menu now has a "Show Recent Inputs" item under the
 
 ** Ispell
 
----
++++
 *** 'ispell-comments-and-strings' now accepts START and END arguments,
 defaulting to active region when used interactively.
 
----
++++
 *** New command 'ispell-comment-or-string-at-point' is provided.
 
 ---