Skip to content

Fix typo and grammar #2842

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

Merged
merged 2 commits into from
Nov 24, 2019
Merged

Fix typo and grammar #2842

merged 2 commits into from
Nov 24, 2019

Conversation

skshetry
Copy link
Collaborator

@skshetry skshetry commented Nov 24, 2019

  • ❗ Have you followed the guidelines in the Contributing to DVC list?

  • πŸ“– Check this box if this PR does not require documentation updates, or if it does and you have created a separate PR in dvc.org with such updates (or at least opened an issue about it in that repo). Please link below to your PR (or issue) in the dvc.org repo.

  • ❌ Have you checked DeepSource, CodeClimate, and other sanity checks below? We consider their findings recommendatory and don't expect everything to be addresses. Please review them carefully and fix those that actually improve code or fix bugs.

Thank you for the contribution - we'll try to review it as soon as possible. πŸ™

This PR fixes:

  • typo in data_cloud.py docstring
  • grammar in PR template

@skshetry
Copy link
Collaborator Author

Grammarly is complaining about the PR template. Fixing it ...

@skshetry skshetry changed the title Fix typo Fix typo and grammar Nov 24, 2019
Copy link
Contributor

@efiop efiop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much @skshetry ! πŸ™

@efiop efiop merged commit 38be142 into iterative:master Nov 24, 2019
@skshetry skshetry deleted the fix-typo branch November 24, 2019 11:06
@casperdcl
Copy link
Contributor

xD I wonder if there's a good spell check integration for code comments & markdown.

Grammar on the other hand is hard. Technically still incorrect even after this PR.

@skshetry
Copy link
Collaborator Author

skshetry commented Nov 24, 2019

@casperdcl, "Inspect Code" on PyCharm also looks through spellcheck on the codebase. I have a WIP branch, but I haven't been able to scan through everything. I'll make a PR sometime this week.

EDIT: Grammar is a different thing, and very hard to get it right (especially for non-native speakers).

@efiop
Copy link
Contributor

efiop commented Nov 24, 2019

@casperdcl Had the same thoughts but I've done some research earlier and haven't been able to find any nice CLI tool to check that in the code πŸ™In any case, nothing beats the perception of a native speaker, so if you see anything wrong with the wording, please let us know or, if you are feeling generous, even create a PR to fix it πŸ™‚

@efiop
Copy link
Contributor

efiop commented Nov 24, 2019

@skshetry PyCharm is really making it tempting to switch to it, I might need to try it out once again πŸ™‚

@casperdcl
Copy link
Contributor

casperdcl commented Nov 26, 2019

@efiop I was wondering about doing something hacky like comparing all words in a diff to a dictionary (with some trickery to find out if it's part of a code comment or markdown). Just a random search shows things like https://rapidapi.com/montanaflynn/api/spellcheck/endpoints. Also aspell, whoosh, pyenchant, and even http://norvig.com/spell-correct.html - tempted to create a repo to do some CI spell checking xD

@ghost
Copy link

ghost commented Nov 26, 2019

@skshetry PyCharm is really making it tempting to switch to it, I might need to try it out once again slightly_smiling_face

@efiop , @casperdcl :set spell πŸ™‚

@ghost
Copy link

ghost commented Nov 26, 2019

Maybe we can enable https://github.com/languagetool-org/languagetool for the CI (btw. it is also available in Vim)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants