search

Wilfred / emacs-refactor

language-specific refactoring in Emacs
GNU General Public License v3.0
348 stars 27 forks source link

fix package-lint warnings #58

Closed conao3 closed 4 years ago

conao3 commented 4 years ago

Hi! I found this package and fix compiler/linter warnings for my contribution first step.

I resolve many issues but some warnings still remained.

before

emr.el

Package should have a Homepage or URL header. (emacs-lisp-package)
Use a properly versioned dependency on "clang-format" if possible. (emacs-lisp-package)
Argument ‘pos’ should appear (as POS) in the doc string (emacs-lisp-checkdoc)
`emr:indexed-lines' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:diff-lines' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:report-action' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:line-visible?' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
"true" should usually be "non-nil" (emacs-lisp-checkdoc)
`emr:refactor-commands' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:documentation' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
Name lisp should appear capitalized as Lisp (emacs-lisp-checkdoc)
Closing parens should not be wrapped onto new lines. (emacs-lisp-package)
`emr:hash-values' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:make-popup' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)

emr-elisp.el

Probably "returns" should be imperative "return" (emacs-lisp-checkdoc)
There should be two spaces after a period (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
Documentation strings should not start or end with whitespace (emacs-lisp-checkdoc)
Documentation strings should not start or end with whitespace (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
Documentation strings should not start or end with whitespace (emacs-lisp-checkdoc)
Documentation strings should not start or end with whitespace (emacs-lisp-checkdoc)
Documentation strings should not start or end with whitespace (emacs-lisp-checkdoc)
Documentation strings should not start or end with whitespace (emacs-lisp-checkdoc)
Probably "Returns" should be imperative "Return" (emacs-lisp-checkdoc)
Lisp symbol ‘beginning-of-defun’ should appear in quotes (emacs-lisp-checkdoc)
Documentation strings should not start or end with whitespace (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
First line is not a complete sentence (emacs-lisp-checkdoc)
Documentation strings should not start or end with whitespace (emacs-lisp-checkdoc)
First line is not a complete sentence (emacs-lisp-checkdoc)
Second line should not have indentation (emacs-lisp-checkdoc)
Argument ‘bindings’ should appear (as BINDINGS) in the doc string (emacs-lisp-checkdoc)
First line is not a complete sentence (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
Documentation strings should not start or end with whitespace (emacs-lisp-checkdoc)
Argument ‘usage’ should appear (as USAGE) in the doc string (emacs-lisp-checkdoc)
Argument ‘def’ should appear (as DEF) in the doc string (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
Argument ‘definition-form’ should appear (as DEFINITION-FORM) in the doc string (emacs-lisp-checkdoc)
Argument ‘definition-form’ should appear (as DEFINITION-FORM) in the doc string (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)

after

emr.el

`emr:indexed-lines' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:diff-lines' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:report-action' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:line-visible?' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:refactor-commands' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:documentation' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:hash-values' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`emr:make-popup' contains a non-standard separator `:', use hyphens instead (see Elisp Coding Conventions). (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)
`eval-after-load' is for use in configurations, and should rarely be used in packages. (emacs-lisp-package)

emr-elisp.el

All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
First line is not a complete sentence (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
All variables and subroutines might as well have a documentation string (emacs-lisp-checkdoc)
coveralls commented 4 years ago

Coverage Status

Coverage decreased (-0.5%) to 60.249% when pulling bcc8d4082be20dffa4775cdc314c14275079b5ac on conao3:fix-warnings into 43a739d462b777a8cb347b758f3bcaac6dc775fc on Wilfred:master.

Wilfred commented 4 years ago

Definitely an improvement! Thank you :)

conao3 commented 4 years ago

Thanks!