Skip to content

Commit

Permalink
Update docstrings and error messages
Browse files Browse the repository at this point in the history
  • Loading branch information
jamescherti committed Sep 11, 2024
1 parent e375a52 commit f79957c
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions flymake-bashate.el
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,10 @@ environment variable."
:pre-let ((bashate-exec (executable-find flymake-bashate-executable)))
:pre-check (progn
(unless bashate-exec
(error "The bashate executable was not found"))
(error "The '%s' executable was not found" bashate-exec))
(unless (numberp flymake-bashate-max-line-length)
(error "The `flymake-bashate-max-line-length' must be a number")))
(error
"The `flymake-bashate-max-line-length' must be a number")))
:write-type 'file
:proc-form `(,bashate-exec
,@(when flymake-bashate-ignore
Expand Down Expand Up @@ -107,7 +108,9 @@ environment variable."

;;;###autoload
(defun flymake-bashate-setup ()
"Enable Flymake and flymake-bashate."
"Set up Flymake for Bashate linting in the current buffer.
This function adds `flymake-bashate-backend' to the list of Flymake diagnostic
functions, enabling Bashate style checks locally for the current buffer."
(add-hook 'flymake-diagnostic-functions #'flymake-bashate-backend nil t))

(provide 'flymake-bashate)
Expand Down

0 comments on commit f79957c

Please sign in to comment.