QA report: lisp-mnt, checkdoc.el, Elint

[jaalto]

FYI,

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

*** Lint Emacs 24.0.92.1 2012-01-04 21:30:22 file: egg.el
** Lint M-x lm-verify (list-mnt.el)
Missing: ;; Maintainer:
Missing: ;; Author:
Missing: ;; Version:
Missing: ;; Keywords:
Missing: ;; URL:
Missing: ;;; Commentary:
Missing: ;;; History:
Missing: ;;; Code:
** Lint M-x checkdoc-current-buffer (checkdoc.el)
egg.el:1002: All variables and subroutines might as well have a documentation string
egg.el:1005: First line is not a complete sentence
egg.el:1032: Documentation strings should not start or end with whitespace
egg.el:1079: First line should be capitalized
egg.el:1100: First line is not a complete sentence
egg.el:1105: First line is not a complete sentence
egg.el:1110: First line is not a complete sentence
egg.el:1110: First line should be capitalized
egg.el:1118: First line is not a complete sentence
egg.el:1138: First line is not a complete sentence
egg.el:1146: All variables and subroutines might as well have a documentation string
egg.el:1156: All variables and subroutines might as well have a documentation string
egg.el:1164: All interactive functions should have documentation
egg.el:1181: All variables and subroutines might as well have a documentation string
egg.el:1184: All variables and subroutines might as well have a documentation string
egg.el:1187: All variables and subroutines might as well have a documentation string
egg.el:1190: All variables and subroutines might as well have a documentation string
egg.el:1194: All variables and subroutines might as well have a documentation string
egg.el:1216: All variables and subroutines might as well have a documentation string
egg.el:1224: Argument `exit-code' should appear (as EXIT-CODE) in the doc string
egg.el:1261: All variables and subroutines might as well have a documentation string
egg.el:1264: All variables and subroutines might as well have a documentation string
egg.el:1271: All variables and subroutines might as well have a documentation string
egg.el:1308: First sentence should end with punctuation
egg.el:1312: Arguments occur in the doc string out of order
egg.el:1388: All variables and subroutines might as well have a documentation string
egg.el:1398: All variables and subroutines might as well have a documentation string
egg.el:1410: All interactive functions should have documentation
egg.el:1436: All variables and subroutines might as well have a documentation string
egg.el:1448: All interactive functions should have documentation
egg.el:1457: First sentence should end with punctuation
egg.el:1495: First line is not a complete sentence
egg.el:1526: First sentence should end with punctuation
egg.el:1572: All interactive functions should have documentation
egg.el:1576: All interactive functions should have documentation
egg.el:1584: All variables and subroutines might as well have a documentation string
egg.el:1587: All variables and subroutines might as well have a documentation string
egg.el:1590: All variables and subroutines might as well have a documentation string
egg.el:1593: All variables and subroutines might as well have a documentation string
egg.el:1596: All variables and subroutines might as well have a documentation string
egg.el:1599: All variables and subroutines might as well have a documentation string
egg.el:1605: All variables and subroutines might as well have a documentation string
egg.el:1611: All variables and subroutines might as well have a documentation string
egg.el:1622: All variables and subroutines might as well have a documentation string
egg.el:1633: All variables and subroutines might as well have a documentation string
egg.el:1637: All variables and subroutines might as well have a documentation string
egg.el:1644: Argument `parent' should appear (as PARENT) in the doc string
egg.el:1651: First line is not a complete sentence
egg.el:1659: Argument `ignored-1' should appear (as IGNORED-1) in the doc string
egg.el:1659: First line is not a complete sentence
egg.el:1697: First line is not a complete sentence
egg.el:1711: First line is not a complete sentence
egg.el:1715: Documentation strings should not start or end with whitespace
egg.el:1899: Argument `args' should appear (as ARGS) in the doc string
egg.el:1963: First line is not a complete sentence
egg.el:1993: Argument `hunk-header' should appear (as HUNK-HEADER) in the doc string
egg.el:2001: Argument `hunk-header' should appear (as HUNK-HEADER) in the doc string
egg.el:2001: Lisp symbol `other-window' should appear in quotes
egg.el:2021: Argument `sect-type' should appear (as SECT-TYPE) in the doc string
egg.el:2055: Argument `reverse' should appear (as REVERSE) in the doc string
egg.el:2069: All variables and subroutines might as well have a documentation string
egg.el:2074: All variables and subroutines might as well have a documentation string
egg.el:2077: All variables and subroutines might as well have a documentation string
egg.el:2081: All variables and subroutines might as well have a documentation string
egg.el:2085: All variables and subroutines might as well have a documentation string
egg.el:2128: Argument `args' should appear (as ARGS) in the doc string
egg.el:2137: Argument `newly-read-state' should appear (as NEWLY-READ-STATE) in the doc string
egg.el:2177: First sentence should end with punctuation
egg.el:2180: Arguments occur in the doc string out of order
egg.el:2180: First line is not a complete sentence
egg.el:2181: Open parenthesis in column 0 should be escaped
egg.el:2197: Argument `win' should appear (as WIN) in the doc string
egg.el:2197: First sentence should end with punctuation
egg.el:2208: Argument `type' should appear (as TYPE) in the doc string
egg.el:2261: First sentence should end with punctuation
egg.el:2270: First line is not a complete sentence
egg.el:2270: Second line should not have indentation
egg.el:2275: Argument `upstream-or-action' should appear (as UPSTREAM-OR-ACTION) in the doc string
egg.el:2303: Argument `callback' should appear (as CALLBACK) in the doc string
egg.el:2345: All interactive functions should have documentation
egg.el:2351: All interactive functions should have documentation
egg.el:2357: All variables and subroutines might as well have a documentation string
egg.el:2464: All interactive functions should have documentation
egg.el:2489: All interactive functions should have documentation
egg.el:2520: Argument `title' should appear (as TITLE) in the doc string
egg.el:2520: Probably "changes" should be imperative "change"
egg.el:2545: Argument `title' should appear (as TITLE) in the doc string
egg.el:2545: Probably "changes" should be imperative "change"
egg.el:2573: All interactive functions should have documentation
egg.el:2607: Argument `help-nav' should appear (as HELP-NAV) in the doc string
egg.el:2633: Argument `proc' should appear (as PROC) in the doc string
egg.el:2644: All variables and subroutines might as well have a documentation string
egg.el:2659: All variables and subroutines might as well have a documentation string
egg.el:2664: All variables and subroutines might as well have a documentation string
egg.el:2670: All variables and subroutines might as well have a documentation string
egg.el:2674: Name emacs should appear capitalized as Emacs
egg.el:2699: All variables and subroutines might as well have a documentation string
egg.el:2767: All variables and subroutines might as well have a documentation string
egg.el:2775: All interactive functions should have documentation
egg.el:2779: All interactive functions should have documentation
egg.el:2783: All interactive functions should have documentation
egg.el:2787: All interactive functions should have documentation
egg.el:2837: All interactive functions should have documentation
egg.el:2854: All variables and subroutines might as well have a documentation string
egg.el:2868: All variables and subroutines might as well have a documentation string
egg.el:2885: All variables and subroutines might as well have a documentation string
egg.el:2896: All variables and subroutines might as well have a documentation string
egg.el:2903: All variables and subroutines might as well have a documentation string
egg.el:2924: All variables and subroutines might as well have a documentation string
egg.el:2942: All variables and subroutines might as well have a documentation string
egg.el:2945: All variables and subroutines might as well have a documentation string
egg.el:2948: All variables and subroutines might as well have a documentation string
egg.el:2951: All variables and subroutines might as well have a documentation string
egg.el:2954: All variables and subroutines might as well have a documentation string
egg.el:2964: All variables and subroutines might as well have a documentation string
egg.el:2971: All variables and subroutines might as well have a documentation string
egg.el:2988: All interactive functions should have documentation
egg.el:2994: All interactive functions should have documentation
egg.el:3001: All interactive functions should have documentation
egg.el:3012: All variables and subroutines might as well have a documentation string
egg.el:3019: All interactive functions should have documentation
egg.el:3027: All interactive functions should have documentation
egg.el:3033: All interactive functions should have documentation
egg.el:3040: All interactive functions should have documentation
egg.el:3059: All interactive functions should have documentation
egg.el:3067: All interactive functions should have documentation
egg.el:3074: All interactive functions should have documentation
egg.el:3081: All variables and subroutines might as well have a documentation string
egg.el:3093: All variables and subroutines might as well have a documentation string
egg.el:3099: All variables and subroutines might as well have a documentation string
egg.el:3109: All variables and subroutines might as well have a documentation string
egg.el:3123: All variables and subroutines might as well have a documentation string
egg.el:3134: All variables and subroutines might as well have a documentation string
egg.el:3144: All variables and subroutines might as well have a documentation string
egg.el:3152: All variables and subroutines might as well have a documentation string
egg.el:3173: All variables and subroutines might as well have a documentation string
egg.el:3222: All variables and subroutines might as well have a documentation string
egg.el:3268: All variables and subroutines might as well have a documentation string
egg.el:3277: All variables and subroutines might as well have a documentation string
egg.el:3286: All interactive functions should have documentation
egg.el:3304: All interactive functions should have documentation
egg.el:3310: Argument `forward' should appear (as FORWARD) in the doc string
egg.el:3348: All variables and subroutines might as well have a documentation string
egg.el:3380: All interactive functions should have documentation
egg.el:3443: All variables and subroutines might as well have a documentation string
egg.el:3532: All variables and subroutines might as well have a documentation string
egg.el:3547: All variables and subroutines might as well have a documentation string
egg.el:3556: All variables and subroutines might as well have a documentation string
egg.el:3615: Argument `default' should appear (as DEFAULT) in the doc string
egg.el:3630: All variables and subroutines might as well have a documentation string
egg.el:3639: All variables and subroutines might as well have a documentation string
egg.el:3648: All variables and subroutines might as well have a documentation string
egg.el:3751: All variables and subroutines might as well have a documentation string
egg.el:3909: All variables and subroutines might as well have a documentation string
egg.el:3920: All interactive functions should have documentation
egg.el:3925: All interactive functions should have documentation
egg.el:3930: All interactive functions should have documentation
egg.el:3937: All interactive functions should have documentation
egg.el:3944: All variables and subroutines might as well have a documentation string
egg.el:3957: All variables and subroutines might as well have a documentation string
egg.el:3965: All variables and subroutines might as well have a documentation string
egg.el:3971: All variables and subroutines might as well have a documentation string
egg.el:3995: All interactive functions should have documentation
egg.el:3999: All interactive functions should have documentation
egg.el:4003: All interactive functions should have documentation
egg.el:4007: All interactive functions should have documentation
egg.el:4011: All interactive functions should have documentation
egg.el:4019: All interactive functions should have documentation
egg.el:4025: All variables and subroutines might as well have a documentation string
egg.el:4042: All variables and subroutines might as well have a documentation string
egg.el:404: Name emacs should appear capitalized as Emacs
egg.el:4090: All variables and subroutines might as well have a documentation string
egg.el:4177: All interactive functions should have documentation
egg.el:4194: All interactive functions should have documentation
egg.el:4207: All interactive functions should have documentation
egg.el:4229: All interactive functions should have documentation
egg.el:4235: All interactive functions should have documentation
egg.el:4241: All interactive functions should have documentation
egg.el:4249: All interactive functions should have documentation
egg.el:4258: All interactive functions should have documentation
egg.el:4266: All interactive functions should have documentation
egg.el:4286: All interactive functions should have documentation
egg.el:4298: All interactive functions should have documentation
egg.el:4314: All interactive functions should have documentation
egg.el:4335: All interactive functions should have documentation
egg.el:4349: All interactive functions should have documentation
egg.el:4361: All interactive functions should have documentation
egg.el:4402: All interactive functions should have documentation
egg.el:4420: All variables and subroutines might as well have a documentation string
egg.el:4430: All interactive functions should have documentation
egg.el:4442: All interactive functions should have documentation
egg.el:4456: All variables and subroutines might as well have a documentation string
egg.el:4494: All interactive functions should have documentation
egg.el:4501: All variables and subroutines might as well have a documentation string
egg.el:4533: All variables and subroutines might as well have a documentation string
egg.el:4543: You should convert this comment to documentation
egg.el:4635: All variables and subroutines might as well have a documentation string
egg.el:4638: All variables and subroutines might as well have a documentation string
egg.el:4641: All variables and subroutines might as well have a documentation string
egg.el:4644: All variables and subroutines might as well have a documentation string
egg.el:4647: All variables and subroutines might as well have a documentation string
egg.el:4650: All variables and subroutines might as well have a documentation string
egg.el:4653: All interactive functions should have documentation
egg.el:4657: All interactive functions should have documentation
egg.el:4662: All variables and subroutines might as well have a documentation string
egg.el:472: First sentence should end with punctuation
egg.el:4775: All variables and subroutines might as well have a documentation string
egg.el:4794: All variables and subroutines might as well have a documentation string
egg.el:4801: All variables and subroutines might as well have a documentation string
egg.el:4821: All interactive functions should have documentation
egg.el:4825: All interactive functions should have documentation
egg.el:4829: All interactive functions should have documentation
egg.el:4833: All interactive functions should have documentation
egg.el:4944: All interactive functions should have documentation
egg.el:4992: All variables and subroutines might as well have a documentation string
egg.el:4997: All variables and subroutines might as well have a documentation string
egg.el:5009: All variables and subroutines might as well have a documentation string
egg.el:5021: All variables and subroutines might as well have a documentation string
egg.el:5055: All interactive functions should have documentation
egg.el:5098: All interactive functions should have documentation
egg.el:5125: All interactive functions should have documentation
egg.el:5148: All variables and subroutines might as well have a documentation string
egg.el:5158: All interactive functions should have documentation
egg.el:5175: All variables and subroutines might as well have a documentation string
egg.el:5215: All interactive functions should have documentation
egg.el:5238: All interactive functions should have documentation
egg.el:5245: All variables and subroutines might as well have a documentation string
egg.el:5255: All variables and subroutines might as well have a documentation string
egg.el:5285: All interactive functions should have documentation
egg.el:5292: All interactive functions should have documentation
egg.el:5303: All interactive functions should have documentation
egg.el:5316: All interactive functions should have documentation
egg.el:5377: All variables and subroutines might as well have a documentation string
egg.el:5400: All variables and subroutines might as well have a documentation string
egg.el:5409: All interactive functions should have documentation
egg.el:5433: All variables and subroutines might as well have a documentation string
egg.el:543: First line should be capitalized
egg.el:5454: All variables and subroutines might as well have a documentation string
egg.el:547: Arguments occur in the doc string out of order
egg.el:547: First line should be capitalized
egg.el:5489: All interactive functions should have documentation
egg.el:548: Lisp symbol `current-buffer' should appear in quotes
egg.el:5513: Argument `ask' should appear (as ASK) in the doc string
egg.el:5524: Argument `no-confirm' should appear (as NO-CONFIRM) in the doc string
egg.el:553: Arguments occur in the doc string out of order
egg.el:553: First line should be capitalized
egg.el:5542: Argument `no-confirm' should appear (as NO-CONFIRM) in the doc string
egg.el:554: Lisp symbol `current-buffer' should appear in quotes
egg.el:5559: All interactive functions should have documentation
egg.el:5563: All variables and subroutines might as well have a documentation string
egg.el:5587: Argument `ask' should appear (as ASK) in the doc string
egg.el:559: Arguments occur in the doc string out of order
egg.el:559: First line should be capitalized
egg.el:5600: All interactive functions should have documentation
egg.el:5620: All interactive functions should have documentation
egg.el:5632: All variables and subroutines might as well have a documentation string
egg.el:564: All variables and subroutines might as well have a documentation string
egg.el:566: All variables and subroutines might as well have a documentation string
egg.el:568: All variables and subroutines might as well have a documentation string
egg.el:5692: All interactive functions should have documentation
egg.el:5704: All interactive functions should have documentation
egg.el:570: All variables and subroutines might as well have a documentation string
egg.el:571: All variables and subroutines might as well have a documentation string
egg.el:5721: All variables and subroutines might as well have a documentation string
egg.el:575: First line should be capitalized
egg.el:5775: All variables and subroutines might as well have a documentation string
egg.el:5786: All variables and subroutines might as well have a documentation string
egg.el:5813: All variables and subroutines might as well have a documentation string
egg.el:582: Argument `re' should appear (as RE) in the doc string
egg.el:582: First line should be capitalized
egg.el:5856: All variables and subroutines might as well have a documentation string
egg.el:5866: All variables and subroutines might as well have a documentation string
egg.el:5905: All interactive functions should have documentation
egg.el:5917: All variables and subroutines might as well have a documentation string
egg.el:5924: All variables and subroutines might as well have a documentation string
egg.el:5934: All variables and subroutines might as well have a documentation string
egg.el:5938: All interactive functions should have documentation
egg.el:594: Argument `re' should appear (as RE) in the doc string
egg.el:594: First line should be capitalized
egg.el:6010: Argument `arg' should appear (as ARG) in the doc string
egg.el:6010: First line is not a complete sentence
egg.el:6023: Documentation strings should not start or end with whitespace
egg.el:6038: All variables and subroutines might as well have a documentation string
egg.el:6066: All variables and subroutines might as well have a documentation string
egg.el:6069: All variables and subroutines might as well have a documentation string
egg.el:6073: All variables and subroutines might as well have a documentation string
egg.el:6076: All variables and subroutines might as well have a documentation string
egg.el:6079: All variables and subroutines might as well have a documentation string
egg.el:6082: All variables and subroutines might as well have a documentation string
egg.el:6085: All variables and subroutines might as well have a documentation string
egg.el:6094: All variables and subroutines might as well have a documentation string
egg.el:612: First line should be capitalized
egg.el:6146: All variables and subroutines might as well have a documentation string
egg.el:616: First line should be capitalized
egg.el:617: Lisp symbol `current-buffer' should appear in quotes
egg.el:6189: All interactive functions should have documentation
egg.el:6194: Argument `nav-regexp' should appear (as NAV-REGEXP) in the doc string
egg.el:6194: Probably "moves" should be imperative "move"
egg.el:621: First line should be capitalized
egg.el:627: First line should be capitalized
egg.el:646: Argument `raw' should appear (as RAW) in the doc string
egg.el:676: All variables and subroutines might as well have a documentation string
egg.el:681: First line should be capitalized
egg.el:729: First line should be capitalized
egg.el:729: Lisp symbol `default-directory' should appear in quotes
egg.el:733: First line should be capitalized
egg.el:737: First line should be capitalized
egg.el:741: First line should be capitalized
egg.el:745: First line should be capitalized
egg.el:749: First line should be capitalized
egg.el:749: Lisp symbol `default-directory' should appear in quotes
egg.el:757: First line should be capitalized
egg.el:762: Argument `error-if-not-git' should appear (as ERROR-IF-NOT-GIT) in the doc string
egg.el:762: First line should be capitalized
egg.el:762: First sentence should end with punctuation
egg.el:762: Lisp symbol `default-directory' should appear in quotes
egg.el:777: First line should be capitalized
egg.el:782: First line should be capitalized
egg.el:817: All variables and subroutines might as well have a documentation string
egg.el:824: Argument `head-properties' should appear (as HEAD-PROPERTIES) in the doc string
egg.el:890: Argument `string' should appear (as STRING) in the doc string
egg.el:890: First sentence should end with punctuation
egg.el:936: You should convert this comment to documentation
egg.el:943: You should convert this comment to documentation
egg.el:950: All variables and subroutines might as well have a documentation string

[byplayer]

Thank you for your information. I'll check it.

[dotemacs]

Some of these issues will be handled by the commit I made earlier SHA: 4b17df9

However, I omitted the .el from the first line of the header. That should be fixed by one of the outstanding pull requests dotemacs/egg@SHA: 2d6691d