Permalink
Browse files

Checkdoc compliance

  • Loading branch information...
1 parent 6afcd87 commit a98a15593290b3c68842007417f03c4c399ae670 @purcell committed Oct 23, 2011
Showing with 6 additions and 3 deletions.
  1. +6 −3 flymake-ruby.el
View
@@ -8,15 +8,18 @@
;; Usage:
;; (require 'flymake-ruby)
;; (add-hook 'ruby-mode-hook 'flymake-ruby-load)
+(require 'flymake)
+;;; Code:
(defconst flymake-ruby-err-line-patterns '(("^\\(.*\\):\\([0-9]+\\): \\(.*\\)$" 1 2 nil 3)))
(defvar flymake-ruby-executable "ruby"
- "The ruby executable to use for syntax checking")
+ "The ruby executable to use for syntax checking.")
;; Invoke ruby with '-c' to get syntax checking
(defun flymake-ruby-init ()
+ "Construct a command that flymake can use to check ruby source."
(list flymake-ruby-executable
(list "-c" (flymake-init-create-temp-buffer-copy
'flymake-create-temp-inplace))))
@@ -26,8 +29,8 @@
"Configure flymake mode to check the current buffer's ruby syntax.
This function is designed to be called in `ruby-mode-hook'; it
-does not alter flymake's global configuration, so `flymake-mode'
-alone will not suffice."
+does not alter flymake's global configuration, so function
+`flymake-mode' alone will not suffice."
(interactive)
(set (make-local-variable 'flymake-allowed-file-name-masks) '(("." flymake-ruby-init)))
(set (make-local-variable 'flymake-err-line-patterns) flymake-ruby-err-line-patterns)

0 comments on commit a98a155

Please sign in to comment.