dired-hacks icon indicating copy to clipboard operation
dired-hacks copied to clipboard

fix package-lint/check-doc/byte-compiler warnings

Open conao3 opened this issue 6 years ago • 1 comments

Hi! I found those packages and fix some package-lint/check-doc/byte-compiler warnings for my first contribution step!

dired-avfs

before

 dired-av…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 dired-a…   122     warning         `y-or-n-p' argument should end with "? " (emacs-lisp-checkdoc)

after

No issues!

dired-collapse

before

 dired-col…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 dired-co…     1  77 warning         You should depend on (emacs "24") if you need lexical-binding. (emacs-lisp-package)
 dired-c…   110     warning         Probably "marks" should be imperative "mark" (emacs-lisp-checkdoc)

after

 dired-c…   111     warning         Probably "marks" should be imperative "mark" (emacs-lisp-checkdoc)

dired-filter

before

 dired-fil…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 dired-f…     1  62 warning         You should depend on (emacs "24") if you need lexical-binding. (emacs-lisp-package)
 dired-f…   397     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-f…   404     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-f…   407     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-f…   513     warning         Messages should start with a capital letter (emacs-lisp-checkdoc)
 dired-f…   608     warning         `y-or-n-p' argument should end with "? " (emacs-lisp-checkdoc)
 dired-…   856     warning         Argument ‘filter’ should appear (as FILTER) in the doc string (emacs-lisp-checkdoc)
 dired-…  1240     warning         Error messages should *not* end with a period (emacs-lisp-checkdoc)
 dired-…  1248     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-…  1277     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-…  1299     warning         Argument ‘prompt’ should appear (as PROMPT) in the doc string (emacs-lisp-checkdoc)
 dired-…  1338     warning         Argument ‘name’ should appear (as NAME) in the doc string (emacs-lisp-checkdoc)
 dired-…  1365     warning         Argument ‘name’ should appear (as NAME) in the doc string (emacs-lisp-checkdoc)

after

 dired-f…   405     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-…   408     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-…  1248     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-…  1277     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-…  1299     warning         Argument ‘prompt’ should appear (as PROMPT) in the doc string (emacs-lisp-checkdoc)
 dired-…  1338     warning         Argument ‘name’ should appear (as NAME) in the doc string (emacs-lisp-checkdoc)
 dired-…  1365     warning         Argument ‘name’ should appear (as NAME) in the doc string (emacs-lisp-checkdoc)

dired-hacks-utils

before

 dired-ha…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 dired-ha…    50   1 error           "dired-hacks-file-size-formatter" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-ha…    57   1 error           "dired-hacks-datetime-regexp" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-ha…    71   1 error           Aliases should start with the package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-ha…    86   1 error           "dired-utils-get-filename" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…    93   1 error           "dired-utils-get-all-files" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   105   1 error           "dired-utils-file-attributes-keywords" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   109   1 error           "dired-utils-info-keywords" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   113   1 error           "dired-utils--get-keyword-info" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   116   6 error           You should depend on (emacs "24.3") or the cl-lib package if you need `cl-case'. (emacs-lisp-package)
 dired-h…   125   1 error           "dired-utils-get-info" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   140   1 error           "dired-utils-goto-line" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   154   1 error           "dired-utils-match-filename-regexp" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   166   1 error           "dired-utils-match-filename-extension" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   177   1 error           "dired-utils-format-information-line" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   195   1 error           "dired-utils-is-file-p" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   199   1 error           "dired-utils-is-dir-p" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   207   1 error           "dired-hacks-next-file" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   227   1 error           "dired-hacks-previous-file" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   246   1 error           "dired-hacks-compare-files" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   263   1 error           "dired-utils-format-information-line-mode" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)

after

 dired-ha…    43   1 error           Cannot open load file: No such file or directory, dash (emacs-lisp)
 dired-ha…    51   1 error           "dired-hacks-file-size-formatter" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-ha…    58   1 error           "dired-hacks-datetime-regexp" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-ha…    72   1 error           Aliases should start with the package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-ha…    87   1 error           "dired-utils-get-filename" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…    94   1 error           "dired-utils-get-all-files" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   106   1 error           "dired-utils-file-attributes-keywords" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   110   1 error           "dired-utils-info-keywords" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   114   1 error           "dired-utils--get-keyword-info" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   126   1 error           "dired-utils-get-info" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   141   1 error           "dired-utils-goto-line" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   155   1 error           "dired-utils-match-filename-regexp" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   167   1 error           "dired-utils-match-filename-extension" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   178   1 error           "dired-utils-format-information-line" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   196   1 error           "dired-utils-is-file-p" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   200   1 error           "dired-utils-is-dir-p" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   208   1 error           "dired-hacks-next-file" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   228   1 error           "dired-hacks-previous-file" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   247   1 error           "dired-hacks-compare-files" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)
 dired-h…   264   1 error           "dired-utils-format-information-line-mode" doesn't start with package's prefix "dired-hacks-utils". (emacs-lisp-package)

conao3 avatar Jan 05 '20 15:01 conao3

dired-list

before

 dired-li…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 dired-li…    48     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 dired-l…    85     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 dired-l…   127     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 dired-l…   186   8 error           You should depend on (emacs "24.3") if you need `read-only-mode'. (emacs-lisp-package)
 dired-l…   257     warning         Probably "ignores" should be imperative "ignore" (emacs-lisp-checkdoc)
 dired-l…   303     warning         Argument ‘cmd’ should appear (as CMD) in the doc string (emacs-lisp-checkdoc)
 dired-l…   328     warning         First line is not a complete sentence (emacs-lisp-checkdoc)

after

 dired-l…    86     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 dired-l…   128     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 dired-l…   258     warning         Probably "ignores" should be imperative "ignore" (emacs-lisp-checkdoc)
 dired-l…   304     warning         Argument ‘cmd’ should appear (as CMD) in the doc string (emacs-lisp-checkdoc)
 dired-l…   329     warning         First line is not a complete sentence (emacs-lisp-checkdoc)

dired-narrow

before

 dired-na…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 dired-n…   103     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-n…   150     warning         Second line should not have indentation (emacs-lisp-checkdoc)
 dired-n…   184     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-n…   267     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-n…   280     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-n…   323     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)

after

 dired-n…    70   1 error           Cannot open load file: No such file or directory, dash (emacs-lisp)
 dired-n…   104     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-n…   185     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-n…   268     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-n…   281     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-n…   324     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)

dired-open

before

 dired-op…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 dired-op…    27     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 dired-op…    34     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 dired-o…   114     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-o…   115     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 dired-o…   122     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-o…   123     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 dired-o…   186     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-o…   213     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-o…   236     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)

after

 dired-o…   115     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-o…   123     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-o…   187     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-o…   214     warning         First line is not a complete sentence (emacs-lisp-checkdoc)
 dired-o…   237     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)

dired-rainbow

before

 dired-ra…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)

after

No issues!

dired-ranger

before

 dired-ra…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 dired-ra…    81     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 dired-ra…    81     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 dired-r…   106     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-r…   154     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-r…   173  22 error           You should depend on (emacs "24.3") or the cl-lib package if you need `cl-incf'. (emacs-lisp-package)
 dired-r…   183     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-r…   198  22 error           You should depend on (emacs "24.3") or the cl-lib package if you need `cl-incf'. (emacs-lisp-package)
 dired-r…   291     warning         `y-or-n-p' argument should end with "? " (emacs-lisp-checkdoc)

after

 dired-ra…    82     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 dired-r…   107     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-r…   155     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-r…   184     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)

dired-subtree

before

 dired-su…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 dired-su…    59     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 dired-s…    88  11 error           You should depend on (emacs "24.3") or the cl-lib package if you need `cl-lib'. (emacs-lisp-package)
 dired-s…   193     warning         Symbols t and nil should not appear in single quotes (emacs-lisp-checkdoc)
 dired-s…   220     warning         Argument ‘p’ should appear (as P) in the doc string (emacs-lisp-checkdoc)
 dired-s…   227     warning         Argument ‘ov’ should appear (as OV) in the doc string (emacs-lisp-checkdoc)
 dired-s…   280     warning         First sentence should end with punctuation (emacs-lisp-checkdoc)
 dired-s…   320     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-s…   328     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-s…   342     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-s…   364     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-s…   412     warning         Argument ‘all’ should appear (as ALL) in the doc string (emacs-lisp-checkdoc)
 dired-s…   435     warning         Argument ‘all’ should appear (as ALL) in the doc string (emacs-lisp-checkdoc)
 dired-s…   462     warning         Argument ‘dir-name’ should appear (as DIR-NAME) in the doc string (emacs-lisp-checkdoc)
 dired-s…   492   8 error           You should depend on (emacs "24.3") if you need `read-only-mode'. (emacs-lisp-package)
 dired-s…   542   8 error           You should depend on (emacs "24.3") if you need `read-only-mode'. (emacs-lisp-package)
 dired-s…   571     warning         Argument ‘depth’ should appear (as DEPTH) in the doc string (emacs-lisp-checkdoc)
 dired-s…   588     warning         First sentence should end with punctuation (emacs-lisp-checkdoc)
 dired-s…   592     warning         Argument ‘max-depth’ should appear (as MAX-DEPTH) in the doc string (emacs-lisp-checkdoc)
 dired-s…   624     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-s…   651     warning         Some lines are over 80 columns wide (emacs-lisp-checkdoc)
 dired-s…   659     warning         Some lines are over 80 columns wide (emacs-lisp-checkdoc)
 dired-s…   667     warning         Argument ‘ov’ should appear (as OV) in the doc string (emacs-lisp-checkdoc)
 dired-s…   676     warning         Argument ‘ov’ should appear (as OV) in the doc string (emacs-lisp-checkdoc)
 dired-s…   705  10 error           You should depend on (emacs "24.3") or the cl-lib package if you need `cl-flet'. (emacs-lisp-package)
 dired-s…   736   1 error           "dired-current-directory" doesn't start with package's prefix "dired-subtree". (emacs-lisp-package)
 dired-s…   737     warning         Argument ‘localp’ should appear (as LOCALP) in the doc string (emacs-lisp-checkdoc)
 dired-s…   762   1 error           "dired-get-subdir" doesn't start with package's prefix "dired-subtree". (emacs-lisp-package)
 dired-s…   763     warning         You should convert this comment to documentation (emacs-lisp-checkdoc)

after

 dired-s…   221     warning         Argument ‘p’ should appear (as P) in the doc string (emacs-lisp-checkdoc)
 dired-s…   228     warning         Argument ‘ov’ should appear (as OV) in the doc string (emacs-lisp-checkdoc)
 dired-s…   321     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-s…   329     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-s…   343     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-s…   365     warning         Argument ‘arg’ should appear (as ARG) in the doc string (emacs-lisp-checkdoc)
 dired-s…   413     warning         Argument ‘all’ should appear (as ALL) in the doc string (emacs-lisp-checkdoc)
 dired-s…   436     warning         Argument ‘all’ should appear (as ALL) in the doc string (emacs-lisp-checkdoc)
 dired-s…   463     warning         Argument ‘dir-name’ should appear (as DIR-NAME) in the doc string (emacs-lisp-checkdoc)
 dired-s…   572     warning         Argument ‘depth’ should appear (as DEPTH) in the doc string (emacs-lisp-checkdoc)
 dired-s…   589     warning         First sentence should end with punctuation (emacs-lisp-checkdoc)
 dired-s…   593     warning         Argument ‘max-depth’ should appear (as MAX-DEPTH) in the doc string (emacs-lisp-checkdoc)
 dired-s…   625     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-s…   652     warning         Some lines are over 80 columns wide (emacs-lisp-checkdoc)
 dired-s…   660     warning         Some lines are over 80 columns wide (emacs-lisp-checkdoc)
 dired-s…   668     warning         Argument ‘ov’ should appear (as OV) in the doc string (emacs-lisp-checkdoc)
 dired-s…   677     warning         Argument ‘ov’ should appear (as OV) in the doc string (emacs-lisp-checkdoc)
 dired-s…   737   1 error           "dired-current-directory" doesn't start with package's prefix "dired-subtree". (emacs-lisp-package)
 dired-s…   738     warning         Argument ‘localp’ should appear (as LOCALP) in the doc string (emacs-lisp-checkdoc)
 dired-s…   763   1 error           "dired-get-subdir" doesn't start with package's prefix "dired-subtree". (emacs-lisp-package)

dired-tagsistant

before

 dired-ta…     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 dired-t…    59     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-t…   147     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-t…   228     warning         Probably "matches" should be imperative "match" (emacs-lisp-checkdoc)
 dired-t…   252  11 error           You should depend on (emacs "24.3") if you need `read-only-mode'. (emacs-lisp-package)
 dired-t…   338     warning         All interactive functions should have documentation (emacs-lisp-checkdoc)

after

 dired-t…    60     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-t…   148     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 dired-t…   229     warning         Probably "matches" should be imperative "match" (emacs-lisp-checkdoc)
 dired-t…   339     warning         All interactive functions should have documentation (emacs-lisp-checkdoc)

conao3 avatar Jan 05 '20 15:01 conao3

I rebased and merged, thanks!

Fuco1 avatar Jun 29 '24 18:06 Fuco1

Thanks!

conao3 avatar Jun 30 '24 02:06 conao3