branch: elpa/beancount
commit 763a8d3fe48b752dd64e8703bdb0afcb8c1327ee
Author: Akira Komamura <[email protected]>
Commit: Martin Blais <[email protected]>
Add docstrings
---
flymake-bean-check.el | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/flymake-bean-check.el b/flymake-bean-check.el
index d70a8d48f8..67d542c035 100644
--- a/flymake-bean-check.el
+++ b/flymake-bean-check.el
@@ -55,12 +55,17 @@
;;;###autoload
(defun flymake-bean-check-enable ()
+ "Enable checking via flymake."
(interactive nil beancount-mode)
(when (buffer-file-name)
(flymake-mode t)
(add-hook 'flymake-diagnostic-functions 'flymake-bean-check--run nil t)))
(defun flymake-bean-check--run (report-fn &rest _ignored)
+ "Perform checking.
+
+This function should be added to `flymake-diagnostic-functions'
+in the enabled buffer. REPORT-FN is a function."
(unless (executable-find flymake-bean-check-executable)
(error "The executable %s doesn't exist. See
`flymake-bean-check-executable'"
flymake-bean-check-executable))
