diff options
Diffstat (limited to 'doc/lispref/tips.texi')
| -rw-r--r-- | doc/lispref/tips.texi | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index 0f883fe4b4d..0695d9b7b12 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi @@ -17,14 +17,15 @@ should follow. @findex checkdoc @findex checkdoc-current-buffer @findex checkdoc-file - You can automatically check some of the conventions described below by -running the command @kbd{M-x checkdoc RET} when visiting a Lisp file. -It cannot check all of the conventions, and not all the warnings it -gives necessarily correspond to problems, but it is worth examining them -all. Alternatively, use the command @kbd{M-x checkdoc-current-buffer RET} -to check the conventions in the current buffer, or @code{checkdoc-file} -when you want to check a file in batch mode, e.g., with a command run by -@kbd{@w{M-x compile RET}}. + You can automatically check some of the conventions described below +by running the command @kbd{M-x checkdoc @key{RET}} when visiting a +Lisp file. It cannot check all of the conventions, and not all the +warnings it gives necessarily correspond to problems, but it is worth +examining them all. Alternatively, use the command @kbd{M-x +checkdoc-current-buffer @key{RET}} to check the conventions in the +current buffer, or @code{checkdoc-file} when you want to check a file +in batch mode, e.g., with a command run by @kbd{@w{M-x compile +@key{RET}}}. @menu * Coding Conventions:: Conventions for clean and robust programs. @@ -1028,7 +1029,7 @@ but only the main one. @findex checkdoc-package-keywords This line lists keywords for the @code{finder-by-keyword} help command. Please use that command to see a list of the meaningful keywords. The -command @kbd{M-x checkdoc-package-keywords RET} will find and display +command @kbd{M-x checkdoc-package-keywords @key{RET}} will find and display any keywords that are not in @code{finder-known-keywords}. If you set the variable @code{checkdoc-package-keywords-flag} non-@code{nil}, checkdoc commands will include the keyword verification in its checks. |