Re: Documentation about elisp code

[Emanuel Berg]

steve-humphreys wrote:

> You are right. I found a missing closing parenthesis.
> Have written a rudimentary message about some help resources
> about some code I have written. Currently I am using the
> *Messages* buffer. I would like to use a special buffer for
> my tools, but do not have experience doing that.

If you are doing an Elisp package byte-compile/improve until
there are no error messages, then do this [1] to look for
docstrings and other issues you might have overlooked, when OK
byte-compile again and all is done.

If you want your own interactive (online) help, sure, you can
have your own buffer for that, see how it is done for example
in this program [2]

What kind of program are you writing BTW? :O

[1]

(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)

https://dataswamp.org/~incal/emacs-init/ide/elisp.el

[2]

(defun print-roll-outs (chainrings sprockets bsd tire)
  (let ((out-buffer (get-buffer-create "*gears*")))
    (with-current-buffer out-buffer
      (goto-char (point-max))
      (print-intro-data chainrings sprockets bsd tire)
      (let ((ros (all-roll-outs chainrings sprockets bsd tire)))
        (cl-loop for ro in ros do
                 (let ((c (   car   ro))
                       (s (   cadr  ro))
                       (r (cl-caddr ro)))
                   (insert (format "% 9d% 14d% 15.0f\n" c s r)) ))))
    (pop-to-buffer out-buffer) ))

https://dataswamp.org/~incal/emacs-init/bike.el

-- 
underground experts united
https://dataswamp.org/~incal