-
Notifications
You must be signed in to change notification settings - Fork 138
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Apply package-lint/elisp-checkdoc suggestions #327
base: master
Are you sure you want to change the base?
Conversation
dash.el
Outdated
@@ -354,7 +356,7 @@ See also `--filter'." | |||
`(--filter (not ,form) ,list)) | |||
|
|||
(defun -remove (pred list) | |||
"Return a new list of the items in LIST for which PRED returns nil. | |||
"Return a new list of the items in LIST for which PRED return nil. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not proper english, unfortunatelly the check is not smart enough to see that. Only the first "return" should be imperative.
dash.el
Outdated
@@ -533,7 +536,7 @@ Thus function FN should return a list." | |||
(defun -flatten (l) | |||
"Take a nested list L and return its contents as a single, flat list. | |||
|
|||
Note that because `nil' represents a list of zero elements (an | |||
Note that because 'nil represents a list of zero elements (an |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe remove the '
also. Not sure which is better but since nobody quotes nil
maybe it shouldn't be.
dash.el
Outdated
@@ -903,7 +906,7 @@ See also: `-drop'" | |||
,l))) | |||
|
|||
(defun -drop-while (pred list) | |||
"Return the tail of LIST starting from the first item for which (PRED item) returns nil." | |||
"Return the tail of LIST starting from the first item for which (PRED item) return nil." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should be conjugated, see previous comment.
dash.el
Outdated
@@ -1600,7 +1604,7 @@ All returned symbols are guaranteed to be unique." | |||
(setq dash--source-counter (1+ dash--source-counter)))) | |||
|
|||
(defun dash--match-ignore-place-p (symbol) | |||
"Return non-nil if SYMBOL is a symbol and starts with _." | |||
"Return non-nil if SYMBOL is a symbol and start with _." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should be conjugated, see previous comment
dash.el
Outdated
@@ -2115,7 +2119,7 @@ because we need to support improper list binding." | |||
(-let* ,new-varlist ,@body))))) | |||
|
|||
(defmacro -lambda (match-form &rest body) | |||
"Return a lambda which destructures its input as MATCH-FORM and executes BODY. | |||
"Return a lambda which destructures its input as MATCH-FORM and execute BODY. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not going to comment on this anymore, but go through it and put back to third person (-s) those where it is gramatically necessary.
Unfortunatelly the "use imperative" lint has extremely bad false-positive ratio. Practically more than 50% of the fixes you made are now gramatically incorrect. I don't know how to silence that particular check, but it's quite useless :( |
a9cfc11
to
24620c3
Compare
I'm not an English native, I misjudged package-lint suggestion. Revert them. |
No problem! I understand it might get confusing, especially since the official linter suggests what is not proper english :( |
Hi! I found this package and found many package-lint/elisp-checkdoc errors.
So I fix them to fix easy as my first contribution step.
before
470 erros/warnings
after
417 errors/warnings