[Emacs-diffs] scratch/flymake-refactor 51533c3 49/52: Capitalize "Flymake" in docstrings and comments

[João Távora]

branch: scratch/flymake-refactor
commit 51533c34f7d0d151a014722b45d79adafc339d68
Author: João Távora <address@hidden>
Commit: João Távora <address@hidden>

    Capitalize "Flymake" in docstrings and comments
    
    * lisp/progmodes/flymake-elisp.el (flymake-elisp-checkdoc)
    (flymake-elisp-setup-backends): Capitalize "Flymake"
    
    * lisp/progmodes/flymake-proc.el:
    (flymake-proc-reformat-err-line-patterns-from-compile-el)
    (flymake-proc--panic, flymake-proc-legacy-flymake)
    (flymake-start-syntax-check, flymake-proc-compile)
    (define-obsolete-variable-alias): Capitalize "Flymake"
    
    * lisp/progmodes/flymake-ui.el (flymake-fringe-indicator-position)
    (flymake-make-diagnostic, flymake-delete-own-overlays)
    (flymake-diagnostic-functions)
    (flymake-diagnostic-types-alist, flymake-is-running)
    (flymake-make-report-fn, flymake-mode-on, flymake-mode-off)
    (flymake-goto-next-error, flymake-goto-prev-error): Capitalize "Flymake"
    
    * lisp/progmodes/flymake.el (flymake-mode-on)
    (flymake-mode-off): Capitalize "Flymake"
---
 lisp/progmodes/flymake-elisp.el |  4 ++--
 lisp/progmodes/flymake-proc.el  | 18 ++++++++---------
 lisp/progmodes/flymake-ui.el    | 43 +++++++++++++++++++++--------------------
 lisp/progmodes/flymake.el       |  4 ++--
 4 files changed, 35 insertions(+), 34 deletions(-)

diff --git a/lisp/progmodes/flymake-elisp.el b/lisp/progmodes/flymake-elisp.el
index a68302c..786bd93 100644
--- a/lisp/progmodes/flymake-elisp.el
+++ b/lisp/progmodes/flymake-elisp.el
@@ -46,7 +46,7 @@
     collected))
 
 (defun flymake-elisp-checkdoc (report-fn)
-  "A flymake backend for `checkdoc'.
+  "A Flymake backend for `checkdoc'.
 Calls REPORT-FN directly."
   (unless (derived-mode-p 'emacs-lisp-mode)
     (error "Can only work on `emacs-lisp-mode' buffers"))
@@ -178,7 +178,7 @@ Runs in a batch-mode Emacs.  Interactively use variable
     (pp collected)))
 
 (defun flymake-elisp-setup-backends ()
-  "Setup flymake for elisp work."
+  "Setup Flymake for elisp work."
   (add-hook 'flymake-diagnostic-functions 'flymake-elisp-checkdoc t t)
   (add-hook 'flymake-diagnostic-functions 'flymake-elisp-byte-compile t t))
 
diff --git a/lisp/progmodes/flymake-proc.el b/lisp/progmodes/flymake-proc.el
index 8dae3a9..973a0d3 100644
--- a/lisp/progmodes/flymake-proc.el
+++ b/lisp/progmodes/flymake-proc.el
@@ -110,14 +110,14 @@ NAME is the file name function to use, default 
`flymake-proc-get-real-file-name'
                               function))))
 
 (defvar-local flymake-proc--current-process nil
-  "Currently active flymake process for a buffer, if any.")
+  "Currently active Flymake process for a buffer, if any.")
 
 (defvar flymake-proc--report-fn nil
   "If bound, function used to report back to flymake's UI.")
 
 (defun flymake-proc-reformat-err-line-patterns-from-compile-el (original-list)
   "Grab error line patterns from ORIGINAL-LIST in compile.el format.
-Convert it to flymake internal format."
+Convert it to Flymake internal format."
   (let* ((converted-list '()))
     (dolist (item original-list)
       (setq item (cdr item))
@@ -624,7 +624,7 @@ Create parent directories as needed."
                (kill-buffer output-buffer)))))))
 
 (defun flymake-proc--panic (problem explanation)
-  "Tell flymake UI about a fatal PROBLEM with this backend.
+  "Tell Flymake UI about a fatal PROBLEM with this backend.
 May only be called in a dynamic environment where
 `flymake-proc--dynamic-report-fn' is bound"
   (flymake-log 0 "%s: %s" problem explanation)
@@ -716,7 +716,7 @@ May only be called in a dynamic environment where
 
 
 (defun flymake-proc-legacy-flymake (report-fn &optional interactive)
-  "Flymake backend based on the original flymake implementation.
+  "Flymake backend based on the original Flymake implementation.
 This function is suitable for inclusion in
 `flymake-dianostic-types-alist'. For backward compatibility, it
 can also be executed interactively independently of
@@ -738,7 +738,7 @@ can also be executed interactively independently of
       (when (process-live-p proc)
         (when interactive
           (user-error
-           "There's already a flymake process running in this buffer")
+           "There's already a Flymake process running in this buffer")
           (kill-process proc))))
     (when
         ;; A number of situations make us not want to error right away
@@ -798,7 +798,7 @@ can also be executed interactively independently of
 
 (define-obsolete-function-alias 'flymake-start-syntax-check
   'flymake-proc-legacy-flymake "26.1"
-  "Flymake backend based on the original flymake implementation.")
+  "Flymake backend based on the original Flymake implementation.")
 
 (defun flymake-proc-stop-all-syntax-checks (&optional reason)
   "Kill all syntax check processes."
@@ -816,7 +816,7 @@ can also be executed interactively independently of
        compilation-in-progress))
 
 (defun flymake-proc-compile ()
-  "Kill all flymake syntax checks, start compilation."
+  "Kill all Flymake syntax checks, start compilation."
   (interactive)
   (flymake-proc-stop-all-syntax-checks "Stopping for proper compilation")
   (call-interactively 'compile))
@@ -1147,7 +1147,7 @@ Nil means search the entire file.")
   (define-obsolete-function-alias 
'flymake-reformat-err-line-patterns-from-compile-el
     'flymake-proc-reformat-err-line-patterns-from-compile-el "26.1"
     "Grab error line patterns from ORIGINAL-LIST in compile.el format.
-Convert it to flymake internal format.")
+Convert it to Flymake internal format.")
   (define-obsolete-variable-alias 'flymake-err-line-patterns
     'flymake-proc-err-line-patterns "26.1"
     "Patterns for matching error/warning lines.  Each pattern has the form
@@ -1166,7 +1166,7 @@ Return its components if so, nil otherwise.")
     "Kill all syntax check processes.")
   (define-obsolete-function-alias 'flymake-compile
     'flymake-proc-compile "26.1"
-    "Kill all flymake syntax checks, start compilation.")
+    "Kill all Flymake syntax checks, start compilation.")
   (define-obsolete-function-alias 'flymake-create-temp-inplace
     'flymake-proc-create-temp-inplace "26.1"
     nil)
diff --git a/lisp/progmodes/flymake-ui.el b/lisp/progmodes/flymake-ui.el
index fef16e5..5de91a4 100644
--- a/lisp/progmodes/flymake-ui.el
+++ b/lisp/progmodes/flymake-ui.el
@@ -88,7 +88,7 @@ this is used."
                        (face :tag "Face"))))
 
 (defcustom flymake-fringe-indicator-position 'left-fringe
-  "The position to put flymake fringe indicator.
+  "The position to put Flymake fringe indicator.
 The value can be nil (do not use indicators), `left-fringe' or `right-fringe'.
 See `flymake-error-bitmap' and `flymake-warning-bitmap'."
   :version "24.3"
@@ -188,7 +188,7 @@ are the string substitutions (see the function `format')."
                                 end
                                 type
                                 text)
-  "Make a flymake diagnostic for BUFFER's region from BEG to END.
+  "Make a Flymake diagnostic for BUFFER's region from BEG to END.
 TYPE is a key to `flymake-diagnostic-types-alist' and TEXT is a
 description of the problem detected in this region."
   (flymake--diag-make :buffer buffer :beg beg :end end :type type :text text))
@@ -227,7 +227,7 @@ verify FILTER, a function, and sort them by COMPARE (using 
KEY)."
         ovs))))
 
 (defun flymake-delete-own-overlays (&optional filter)
-  "Delete all flymake overlays in BUFFER."
+  "Delete all Flymake overlays in BUFFER."
   (mapc #'delete-overlay (flymake--overlays :filter filter)))
 
 (defface flymake-error
@@ -303,12 +303,12 @@ about where and how to annotate problems diagnosed in a 
buffer.
 
 Whenever Flymake or the user decides to re-check the buffer, each
 function is called with a common calling convention, a single
-REPORT-FN argument, detailed below.  Backend functions are
-expected to initiate the buffer check, but aren't required to
-complete it check before exiting: if the computation involved is
-expensive, especially for large buffers, that task can be
-scheduled for the future using asynchronous processes or other
-asynchronous mechanisms.
+REPORT-FN argument and a list of keword value pairs, detailed
+below.  Backend functions are expected to initiate the buffer
+check, but aren't required to complete it check before exiting:
+if the computation involved is expensive, especially for large
+buffers, that task can be scheduled for the future using
+asynchronous processes or other asynchronous mechanisms.
 
 In any case, backend functions are expected to return quickly or
 signal an error, in which case the backend is disabled.  Flymake
@@ -319,7 +319,7 @@ and on again, reset the list of disabled backends.
 If the function returns, Flymake considers the backend to be
 \"running\". If it has not done so already, the backend is
 expected to call the function REPORT-FN with a single argument
-ACTION followed by an optional list of keyword arguments and
+ACTION followed by an optional list of keyword-value pairs
 their values (:KEY1 VALUE1 :KEY2 VALUE2...).
 
 The possible values for ACTION are.
@@ -355,7 +355,7 @@ The recognized optional keyword arguments are:
      . ((flymake-category . flymake-warning)))
     (:note
      . ((flymake-category . flymake-note))))
-  "Alist ((KEY . PROPS)*) of properties of flymake error types.
+  "Alist ((KEY . PROPS)*) of properties of Flymake error types.
 KEY can be anything passed as `:type' to `flymake-diag-make'.
 
 PROPS is an alist of properties that are applied, in order, to
@@ -488,7 +488,7 @@ return DEFAULT."
        (flymake-log 3 "starting syntax check as more than 1 second passed 
since last change")
        (flymake-start)))))
 
-;; Nothing in flymake uses this at all any more, so this is just for
+;; Nothing in Flymake uses this at all any more, so this is just for
 ;; third-party compatibility.
 (define-obsolete-function-alias 'flymake-display-warning 'message-box "26.1")
 
@@ -522,10 +522,11 @@ present the backend is disabled.")
          (puthash ,b ,state-var flymake--backend-state)))))
 
 (defun flymake-is-running ()
-  "Tell if flymake has running backends in this buffer"
+  "Tell if Flymake has running backends in this buffer"
   (flymake-running-backends))
 
-(cl-defun flymake--handle-report (backend token action &key explanation force)
+(cl-defun flymake--handle-report (backend token action
+                                          &key explanation force)
   "Handle reports from BACKEND identified by TOKEN.
 
 BACKEND, ACTION and EXPLANATION, and FORCE conform to the calling
@@ -584,8 +585,8 @@ not expected."
 
 (defun flymake-make-report-fn (backend &optional token)
   "Make a suitable anonymous report function for BACKEND.
-BACKEND is used to help flymake distinguish different diagnostic
-sources.  If provided, TOKEN helps flymake distinguish between
+BACKEND is used to help Flymake distinguish different diagnostic
+sources.  If provided, TOKEN helps Flymake distinguish between
 different runs of the same backend."
   (let ((buffer (current-buffer)))
     (lambda (&rest args)
@@ -709,12 +710,12 @@ Interactively, with a prefix arg, FORCE is t."
       (setq flymake-timer nil)))))
 
 (defun flymake-mode-on ()
-  "Turn flymake mode on."
+  "Turn Flymake mode on."
   (flymake-mode 1)
   (flymake-log 1 "flymake mode turned ON"))
 
 (defun flymake-mode-off ()
-  "Turn flymake mode off."
+  "Turn Flymake mode off."
   (flymake-mode 0)
   (flymake-log 1 "flymake mode turned OFF"))
 
@@ -747,7 +748,7 @@ Interactively, with a prefix arg, FORCE is t."
     (flymake-log 3 "automatically turned ON")))
 
 (defun flymake-goto-next-error (&optional n filter interactive)
-  "Go to Nth next flymake error in buffer matching FILTER.
+  "Go to Nth next Flymake error in buffer matching FILTER.
 
 Interactively, always move to the next error.  Interactively, and
 with a prefix arg, skip any diagnostics with a severity less than
@@ -797,13 +798,13 @@ applied."
               (funcall (overlay-get target 'help-echo)
                        nil nil (point)))))
           (interactive
-           (user-error "No more flymake errors%s"
+           (user-error "No more Flymake errors%s"
                        (if filter
                            (format " of types %s" filter)
                          ""))))))
 
 (defun flymake-goto-prev-error (&optional n filter interactive)
-  "Go to Nth previous flymake error in buffer matching FILTER.
+  "Go to Nth previous Flymake error in buffer matching FILTER.
 
 Interactively, always move to the previous error.  Interactively,
 and with a prefix arg, skip any diagnostics with a severity less
diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el
index aa89417..f7027d1 100644
--- a/lisp/progmodes/flymake.el
+++ b/lisp/progmodes/flymake.el
@@ -38,10 +38,10 @@
 ;;; flymake-ui.el where they actually live.
 
 ;;;###autoload
-(defun flymake-mode-on () "Turn flymake mode on." nil)
+(defun flymake-mode-on () "Turn Flymake mode on." nil)
 
 ;;;###autoload
-(defun flymake-mode-off () "Turn flymake mode off." nil)
+(defun flymake-mode-off () "Turn Flymake mode off." nil)
 
 ;;;###autoload
 (define-minor-mode flymake-mode nil)