Fix wide docstrings #1760
Merged
Fix wide docstrings #1760
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bbatsov
reviewed
Mar 12, 2022
projectile.el
Outdated
| @@ -1230,7 +1230,8 @@ explicitly." | |||
| (projectile-project-root (or dir default-directory))) | |||
|
|
|||
| (defun projectile-default-project-name (project-root) | |||
| "Default function used create project name to be displayed based on the value of PROJECT-ROOT." | |||
| "Default function used create project name to be displayed based on the | |||
There was a problem hiding this comment.
Checkdoc wants the first line of the docstring to be a complete sentence. This way we're solving one problem, but introducing another one.
There was a problem hiding this comment.
There are numerous other checkdoc warnings as well. But I agree we should not make it worse. Some of the others ones are really easy to fix but I'll leave that out of this pull request.
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The byte compiler in Emacs 28 show warnings for "docstring wider than 80 characters" in multiple places. These warnings are show every time the package is updated from list-packages so it's visible for the user.
I mostly just used fill-paragraph to fix these docstrings.