help-gnu-emacs
[Top][All Lists]
Advanced
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Defun Self Documentation

From: Emanuel Berg
Subject: Re: Defun Self Documentation
Date: Thu, 05 Nov 2020 19:41:14 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) 
When writing a docstring to a function make sure all the arguments
appear, all in UPPERCASE, and in the same order they are passed to
the function.

Use this to verify:

(require 'checkdoc)

(setq checkdoc-permit-comma-termination-flag t)

(defun check-package-style ()
  (interactive)
  (let ((msg "Style check..."))
    (message msg)
    (checkdoc-current-buffer t) ; TAKE-NOTES
    (message "%sdone" msg) ))
(defalias 'check-style #'check-package-style)

-- 
underground experts united
http://user.it.uu.se/~embe8573
https://dataswamp.org/~incal
reply via email to
[Prev in Thread] Current Thread [Next in Thread]