dimitri/cssh — Issue #5: QA problems - Lisp-mnt, Elint, Checkdoc
Author: jaalto
Created: 2012-01-02 18:18:43+00:00
State: open

FYI,

Perhaps these could be addressed in later releases. See lm-* exected file syntax e.g. at
"D.8 Library Headers (GNU Emacs Lisp Reference Manual)"
http://pinboard.in/u:jariaalto/t:emacs/t:elisp/t:qa

*** Lint 2012-01-02 20:15:21 file: ~/vc/epackage/pkg/cssh-mode.fork/cssh.el
** Lint M-x lm-verify (list-mnt.el)
Missing: ;;; Commentary:
Missing: ;;; History:
Missing: ;;; Code:
Missing: ;; Maintainer:
** Lint miscellaneous
** Lint M-x checkdoc-current-buffer (checkdoc.el)
cssh.el:101: First line should be capitalized
cssh.el:101: First sentence should end with punctuation
cssh.el:105: First line should be capitalized
cssh.el:105: First sentence should end with punctuation
cssh.el:109: First sentence should end with punctuation
cssh.el:141: First line should be capitalized
cssh.el:141: First sentence should end with punctuation
cssh.el:155: All variables and subroutines might as well have a documentation string
cssh.el:158: Keycode C-c embedded in doc string. Use \\ & \\[function] instead
cssh.el:162: Keycode C-c embedded in doc string. Use \\ & \\[function] instead
cssh.el:174: First line should be capitalized
cssh.el:174: First sentence should end with punctuation
cssh.el:180: Argument `dsh-path' should appear (as DSH-PATH) in the doc string
cssh.el:180: First sentence should end with punctuation
cssh.el:180: Probably "Returns" should be imperative "Return"
cssh.el:193: First line is not a complete sentence
cssh.el:193: Probably "Returns" should be imperative "Return"
cssh.el:194: Lisp symbol `cssh-dsh-path' should appear in quotes
cssh.el:200: Argument `remote-host' should appear (as REMOTE-HOST) in the doc string
cssh.el:258: Argument `cssh-buffer-name' should appear (as CSSH-BUFFER-NAME) in the doc string
cssh.el:258: First line should be capitalized
cssh.el:258: First sentence should end with punctuation
cssh.el:292: Argument `cssh-buffer-name' should appear (as CSSH-BUFFER-NAME) in the doc string
cssh.el:292: First line should be capitalized
cssh.el:292: First sentence should end with punctuation
cssh.el:304: Argument `cssh-buffer-name' should appear (as CSSH-BUFFER-NAME) in the doc string
cssh.el:304: First line is not a complete sentence
cssh.el:304: First line should be capitalized
cssh.el:326: Argument `filename' should appear (as FILENAME) in the doc string
cssh.el:326: First line is not a complete sentence
cssh.el:343: Argument `filename' should appear (as FILENAME) in the doc string
cssh.el:343: First line is not a complete sentence
cssh.el:360: Argument `group' should appear (as GROUP) in the doc string
cssh.el:360: First sentence should end with punctuation
cssh.el:381: Argument `cssh-buffer-name' should appear (as CSSH-BUFFER-NAME) in the doc string
cssh.el:381: First line should be capitalized
cssh.el:381: First sentence should end with punctuation
cssh.el:415: First line should be capitalized
cssh.el:415: First sentence should end with punctuation
cssh.el:415: Keycode C-a embedded in doc string. Use \\ & \\[function] instead
cssh.el:452: Argument `string' should appear (as STRING) in the doc string
cssh.el:452: First line should be capitalized
cssh.el:452: First sentence should end with punctuation
cssh.el:462: Argument `term-fun' should appear (as TERM-FUN) in the doc string
cssh.el:462: First line should be capitalized
cssh.el:462: First sentence should end with punctuation
cssh.el:470: All interactive functions should have documentation
cssh.el:477: All interactive functions should have documentation
cssh.el:482: First line should be capitalized
cssh.el:482: First sentence should end with punctuation
cssh.el:499: All interactive functions should have documentation
cssh.el:503: All interactive functions should have documentation
cssh.el:507: All interactive functions should have documentation
cssh.el:511: All interactive functions should have documentation
cssh.el:527: Argument `backward?' should appear (as BACKWARD?) in the doc string
cssh.el:527: First line is not a complete sentence
cssh.el:527: First line should be capitalized
cssh.el:543: Argument `backward?' should appear (as BACKWARD?) in the doc string
cssh.el:543: First sentence should end with punctuation
cssh.el:551: Argument `buffer-list' should appear (as BUFFER-LIST) in the doc string
cssh.el:551: First line should be capitalized
cssh.el:551: First sentence should end with punctuation
cssh.el:84: First sentence should end with punctuation
cssh.el:89: First line should be capitalized
cssh.el:89: First sentence should end with punctuation
cssh.el:93: First line should be capitalized
cssh.el:93: First sentence should end with punctuation
cssh.el:97: First line should be capitalized
cssh.el:97: First sentence should end with punctuation