Fix documentation errors and spelling #4
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
ma-ilsi
force-pushed
the
doc-fixes
branch
2 times, most recently
from
b3a3172 to
04bbd27
Compare
Corrects function usage example for text_dublication_detector.py. Corrects minor spelling errors in project README files.
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 function usage example for
text_dublication_detector.pywas missing the deleted filename parameter and the column parametersentenceswas not a string. The current fix corrects this and makes the usage example much more clearer.Minor spelling mistakes in the project README files have also been corrected.
Another small documentation problem was found in
parser.py:69. It is a syntax warning for the lone\character which Python sees as the beginning of an escape sequence. However, I have not corrected it assuming you guys must've seen that warning many times and do not care.