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

[conao3]

Hi! I found this package and I fix flycheck warnings for my first contribution step!

before

 async.el     1   1 warning         Including "Emacs" in the package summary is usually redundant. (emacs-lisp-package)
 async.el     1   1 error           Package should have a Homepage or URL header. (emacs-lisp-package)
 async.el     1  55 warning         You should depend on (emacs "24") if you need lexical-binding. (emacs-lisp-package)
 async.el     9   4 warning         You should include standard keywords: see the variable `finder-known-keywords'. (emacs-lisp-package)
 async.el    34  30 error           You should depend on (emacs "24.3") or the cl-lib package if you need `cl-lib'. (emacs-lisp-package)
 async.el    63  11 error           You should depend on (emacs "24.3") or the cl-lib package if you need `cl-loop'. (emacs-lisp-package)
 async.el    95     warning         Lisp symbol ‘syntax-table’ should appear in quotes (emacs-lisp-checkdoc)
 async.el   140     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 async.el   154     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 async.el   178     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 async.el   190     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 async.el   202     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 async.el   209     warning         Lisp symbol ‘command-line’ should appear in quotes (emacs-lisp-checkdoc)
 async.el   255     warning         "true" should usually be "non-nil" (emacs-lisp-checkdoc)
 async.el   260     warning         Argument ‘args’ should appear (as ARGS) in the doc string (emacs-lisp-checkdoc)
 async.el   273     warning         Argument ‘name’ should appear (as NAME) in the doc string (emacs-lisp-checkdoc)
 async.el   290     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 async.el   371     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 async.el   380     warning         Argument ‘bindings’ should appear (as BINDINGS) in the doc string (emacs-lisp-checkdoc)
 async.el   397  18 error           You should depend on (emacs "24.1") if you need `pcase'. (emacs-lisp-package)

after

 async.el   140     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 async.el   154     warning         Argument ‘proc’ should appear (as PROC) in the doc string (emacs-lisp-checkdoc)
 async.el   178     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 async.el   190     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 async.el   202     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 async.el   260     warning         Argument ‘args’ should appear (as ARGS) in the doc string (emacs-lisp-checkdoc)
 async.el   290     warning         Name emacs should appear capitalized as Emacs (emacs-lisp-checkdoc)
 async.el   371     warning         All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
 async.el   380     warning         Argument ‘bindings’ should appear (as BINDINGS) in the doc string (emacs-lisp-checkdoc)

[thierryvolpiatto]

Naoya Yamashita notifications@github.com writes:

Hi! I found this package and I fix flycheck warnings for my first contribution step!

Thanks.

For dependencies, they should be added in the *pkg.el file, no need to add them in async.el except for the Elpa branch, like this:

diff --git a/async-pkg.el b/async-pkg.el index 815c100..b277b17 100644 --- a/async-pkg.el +++ b/async-pkg.el @@ -1,7 +1,7 @@ ;;; async-pkg.el --- Generated package description from async.el (define-package "async" "1.9.4" "Asynchronous processing in Emacs"

• 'nil
• '((emacs "24.3")) :url "https://github.com/jwiegley/emacs-async" :keywords '("async"))

-- Thierry

Get my Gnupg key: gpg --keyserver pgp.mit.edu --recv-keys 59F29997

[conao3]

Thanks. BTW, why *pkg file exist? One piece of information should be written in one place. This time you could prevent it, but we can easily imagine that this kind of human error will happen.

[thierryvolpiatto]

Naoya Yamashita notifications@github.com writes:

Thanks. BTW, why *pkg file exist?

As soon as we have more than one file, it is better to have a pkg.el file, specially for Melpa, see Melpa documentation for more infos. There is a disagrement with emacs devel about usage of pkg files, IMO all the infos needed for packaging have nothing to do in source files whereas Elpa requires to have these infos in source files.

One piece of information should be written in one place. This time you could prevent it, but we can easily imagine that this kind of human error will happen.

Yes of course, it is why I now focus mostly on the github version of async and not on the Elpa one.

-- Thierry

Get my Gnupg key: gpg --keyserver pgp.mit.edu --recv-keys 59F29997

[thierryvolpiatto]

Thanks, merged.

[conao3]

Thanks too. And the additional information was very helpful, thanks.