Fix checkdoc warnings #834
Open
Conversation
This file contains hidden or 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
Went from 708 checkdoc warnings to 21
MorganJamesSmith
force-pushed
the
master
branch
from
45f1ca6 to
3562179
Compare
Author
|
I just rebased this and fixed all merge conflicts |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Hello! I am new to contributing to ProofGeneral.
Emacs now has a builtin utility called checkdoc to check docstrings and general file format. It also enables running a spell checker on all the docstrings.
Here I have added a make target to run this utility along with a dictionary of words that I assume are not typo's yet are not found in my ispell dictionary.
Running checkdoc yields 779 warnings. I have gone through an fixed most of them and I am now down to 29 warnings.
Please let me know what you think. Thank you for taking a look!