search

skeeto / impatient-mode

Impatient html mode. See your changes in the browser as you type
215 stars 19 forks source link

Solve package-lint/check-doc/byte-compiler warnings #25

Closed conao3 closed 4 years ago

conao3 commented 4 years ago

Hi! I found this package, I fix some pacakge-lint/check-doc/byte-compiler warnings.

before

 impatien…     1  60 warning         You should depend on (emacs "24") if you need lexical-binding. (emacs-lisp-package)
 impatien…    13     warning         There should be two spaces after a period (emacs-lisp-checkdoc)
 impatien…    17     warning         There should be two spaces after a period (emacs-lisp-checkdoc)
 impatien…    18     warning         There should be two spaces after a period (emacs-lisp-checkdoc)
 impatien…    24     warning         There should be two spaces after a period (emacs-lisp-checkdoc)
 impatien…    32     warning         There should be two spaces after a period (emacs-lisp-checkdoc)
 impatien…    33     warning         There should be two spaces after a period (emacs-lisp-checkdoc)
 impatien…    43   1 error           Customization groups should not end in "-mode" unless that name would conflict with their parent group. (emacs-lisp-package)
 impatien…    51     warning         Second line should not have indentation (emacs-lisp-checkdoc)
 impatien…    51     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 impatien…    54   1 error           "imp--idle-timer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    54   2 error           You should depend on (emacs "24.3") if you need `defvar-local'. (emacs-lisp-package)
 impatien…    57   1 error           "imp-user-filter" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    57   2 error           You should depend on (emacs "24.3") if you need `defvar-local'. (emacs-lisp-package)
 impatien…    60   1 error           "imp-client-list" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    60   2 error           You should depend on (emacs "24.3") if you need `defvar-local'. (emacs-lisp-package)
 impatien…    63   1 error           "imp-last-state" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    63   2 error           You should depend on (emacs "24.3") if you need `defvar-local'. (emacs-lisp-package)
 impatien…    66   1 error           "imp-related-files" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    66   2 error           You should depend on (emacs "24.3") if you need `defvar-local'. (emacs-lisp-package)
 impatien…    69   1 error           "imp--buffer-dirty-p" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    69   2 error           You should depend on (emacs "24.3") if you need `defvar-local'. (emacs-lisp-package)
 impatien…    72   1 error           "imp-default-user-filters" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    92   1 error           "imp-shim-root" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    95   1 error           "imp-set-user-filter" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…    96     warning         Probably "Sets" should be imperative "Set" (emacs-lisp-checkdoc)
 impatie…   105   1 error           "imp-remove-user-filter" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   106     warning         Probably "Sets" should be imperative "Set" (emacs-lisp-checkdoc)
 impatie…   115   1 error           "imp-htmlize-filter" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   116     warning         Argument ‘buffer’ should appear (as BUFFER) in the doc string (emacs-lisp-checkdoc)
 impatie…   121   1 error           "imp-toggle-htmlize" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   128   1 error           "imp-visit-buffer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   129     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 impatie…   141   1 error           "imp-buffer-enabled-p" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   142     warning         Argument ‘buffer’ should appear (as BUFFER) in the doc string (emacs-lisp-checkdoc)
 impatie…   145   1 error           "imp--buffer-list" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   146     warning         First sentence should end with punctuation (emacs-lisp-checkdoc)
 impatie…   149   1 error           "imp--should-not-cache-p" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   150     warning         First sentence should end with punctuation (emacs-lisp-checkdoc)
 impatie…   150     warning         Argument ‘path’ should appear (as PATH) in the doc string (emacs-lisp-checkdoc)
 impatie…   155   1 error           "httpd/imp/static" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   155   1 error           `httpd/imp/static' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
 impatie…   156     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 impatie…   163   1 error           "imp-serve-buffer-list" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   164     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 impatie…   179   1 error           "imp--private" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   180     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 impatie…   183   1 error           "httpd/imp/live" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   183   1 error           `httpd/imp/live' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
 impatie…   184     warning         First sentence should end with punctuation (emacs-lisp-checkdoc)
 impatie…   184     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 impatie…   184     warning         Probably "lets" should be imperative "let" (emacs-lisp-checkdoc)
 impatie…   218   1 error           "httpd/imp" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   218   1 error           `httpd/imp' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
 impatie…   219     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 impatie…   224   1 error           "imp--send-state" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   225     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 impatie…   236   1 error           "imp--send-state-ignore-errors" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   237     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 impatie…   241   1 error           "imp--notify-clients" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   242     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 impatie…   245   1 error           "imp--cleanup-timer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   251   1 error           "imp--start-idle-timer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   276   1 error           "imp--on-change" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   283   1 error           "imp--after-timeout" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   284     warning         First sentence should end with punctuation (emacs-lisp-checkdoc)
 impatie…   284     warning         Probably "Executes" should be imperative "Execute" (emacs-lisp-checkdoc)
 impatie…   289   1 error           "imp--update-buffer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   302   1 error           "httpd/imp/buffer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   302   1 error           `httpd/imp/buffer' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
 impatie…   303     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)

after

 impatien…    53   1 error           "imp-default-user-filters" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    60   1 error           "imp--idle-timer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    63   1 error           "imp-user-filter" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    66   1 error           "imp-client-list" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    69   1 error           "imp-last-state" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    72   1 error           "imp-related-files" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    75   1 error           "imp--buffer-dirty-p" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatien…    95   1 error           "imp-shim-root" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…    98   1 error           "imp-set-user-filter" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   108   1 error           "imp-remove-user-filter" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   118   1 error           "imp-htmlize-filter" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   124   1 error           "imp-toggle-htmlize" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   131   1 error           "imp-visit-buffer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   144   1 error           "imp-buffer-enabled-p" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   148   1 error           "imp--buffer-list" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   152   1 error           "imp--should-not-cache-p" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   158   1 error           "httpd/imp/static" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   158   1 error           `httpd/imp/static' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
 impatie…   159     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 impatie…   166   1 error           "imp-serve-buffer-list" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   167     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 impatie…   182   1 error           "imp--private" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   183     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 impatie…   186   1 error           "httpd/imp/live" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   186   1 error           `httpd/imp/live' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
 impatie…   187     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 impatie…   187     warning         Probably "lets" should be imperative "let" (emacs-lisp-checkdoc)
 impatie…   221   1 error           "httpd/imp" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   221   1 error           `httpd/imp' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
 impatie…   222     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 impatie…   227   1 error           "imp--send-state" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   228     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 impatie…   239   1 error           "imp--send-state-ignore-errors" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   240     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 impatie…   244   1 error           "imp--notify-clients" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   245     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 impatie…   248   1 error           "imp--cleanup-timer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   254   1 error           "imp--start-idle-timer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   279   1 error           "imp--on-change" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   286   1 error           "imp--after-timeout" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   292   1 error           "imp--update-buffer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   305   1 error           "httpd/imp/buffer" doesn't start with package's prefix "impatient". (emacs-lisp-package)
 impatie…   305   1 error           `httpd/imp/buffer' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
 impatie…   306     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
conao3 commented 4 years ago

Thanks!

skeeto commented 4 years ago

Prior to this, I already thought the linter was too opinionated in some cases, and this certainly doesn't change my opinion (it's simply wrong about two spaces between sentences), but since you did all the legwork I have no reason to reject it. Thanks!