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

Add DocGrammarBear for docstrings #1980

Merged
merged 1 commit into from Aug 16, 2017

Conversation

6 participants
@damngamerz
Member

damngamerz commented Aug 5, 2017

This bear checks for spellings and grammatical mistakes
on the descriptions of documentation comments.

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

  • I read the commit guidelines and I've followed
    them.
  • I ran coala over my code locally. (All commits have to pass
    individually.
    It is not sufficient to have "fixup commits" on your PR,
    our bot will still report the issues for the previous commit.) You will
    likely receive a lot of bot comments and build failures if coala does not
    pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

@gitmate-bot

This comment has been minimized.

Show comment
Hide comment
@gitmate-bot

gitmate-bot Aug 5, 2017

Collaborator

Comment on ae7a1d9.

No newline found between shortlog and body at HEAD commit. Please add one.

GitCommitBear, severity NORMAL, section commit.

Collaborator

gitmate-bot commented Aug 5, 2017

Comment on ae7a1d9.

No newline found between shortlog and body at HEAD commit. Please add one.

GitCommitBear, severity NORMAL, section commit.

@NiklasMM

Please do not read test data from files, it's very hard to read the tests this way. Rather define the file content inside the test file. You can do that using string literals or even more conveniently, by building DocComment objects and assembling them

Show outdated Hide outdated bears/documentation/DocGrammarBear.py
Show outdated Hide outdated bears/documentation/DocGrammarBear.py
Show outdated Hide outdated bears/documentation/DocGrammarBear.py
@SanketDG

looks good, small changes needed

@NiklasMM

Looks good, the test suite looks much nicer now. I still recommend you use pytest's parametrize to get rid of more boilerplate code.

Things I'm missing in the testsuite:

  • Tests for a programming language that isn't Python
  • Tests for a natural language that isn't English
and grammatic rules via LanguageTool.
:param parsed:
Contains parsed documentation comment.

This comment has been minimized.

@NiklasMM

NiklasMM Aug 10, 2017

Contributor

Is this a DocComment object? If so, why not mention it?

@NiklasMM

NiklasMM Aug 10, 2017

Contributor

Is this a DocComment object? If so, why not mention it?

This comment has been minimized.

@damngamerz

damngamerz Aug 11, 2017

Member

no this is DocComment.parse() parsed documentation comment.

@damngamerz

damngamerz Aug 11, 2017

Member

no this is DocComment.parse() parsed documentation comment.

Show outdated Hide outdated tests/documentation/DocGrammarBearTest.py
Show outdated Hide outdated tests/documentation/DocGrammarBearTest.py
Show outdated Hide outdated tests/documentation/DocGrammarBearTest.py
Show outdated Hide outdated tests/documentation/DocGrammarBearTest.py
Show outdated Hide outdated tests/documentation/DocGrammarBearTest.py
Add DocGrammarBear for docstrings
This bear checks for spellings and grammatical mistakes
on the descriptions of documentation comments.
@SanketDG

This comment has been minimized.

Show comment
Hide comment
@SanketDG
Member

SanketDG commented Aug 16, 2017

ack 112fa7d

@SanketDG

This comment has been minimized.

Show comment
Hide comment
@SanketDG
Member

SanketDG commented Aug 16, 2017

@rultor merge

@rultor

This comment has been minimized.

Show comment
Hide comment
@rultor

rultor Aug 16, 2017

@rultor merge

@SanketDG OK, I'll try to merge now. You can check the progress of the merge here

rultor commented Aug 16, 2017

@rultor merge

@SanketDG OK, I'll try to merge now. You can check the progress of the merge here

@rultor rultor merged commit 112fa7d into coala:master Aug 16, 2017

6 of 9 checks passed

ci/circleci CircleCI is running your tests
Details
continuous-integration/appveyor/branch Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/push The Travis CI build is in progress
Details
codecov/project 100% (target 100%)
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
review/gitmate/commit No issues with this one - go ahead! :)
Details
review/gitmate/manual This commit was acknowledged.
Details
review/gitmate/pr All is well! :) (0 problems solved)
Details
@rultor

This comment has been minimized.

Show comment
Hide comment
@rultor

rultor Aug 16, 2017

@rultor merge

@SanketDG Done! FYI, the full log is here (took me 2min)

rultor commented Aug 16, 2017

@rultor merge

@SanketDG Done! FYI, the full log is here (took me 2min)

@damngamerz damngamerz deleted the damngamerz:docgrammarbear branch Aug 16, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment