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

DocumentationAPI: Add `MalformedComment` #4637

Merged
merged 2 commits into from Aug 17, 2017

Conversation

6 participants
@damngamerz
Member

damngamerz commented Aug 11, 2017

MalformedComment is the new error handling mechanism
in DocumentationAPI. Which will help in yielding a
subsequent RESULT with a beautiful message in the bear.

Closes #4548

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!

@Nosferatul

This comment has been minimized.

Show comment
Hide comment
@Nosferatul

Nosferatul Aug 12, 2017

Member

looks good to me 👍

Member

Nosferatul commented Aug 12, 2017

looks good to me 👍

@damngamerz damngamerz changed the title from DocumentationAPI: Markers faulty message logging to DocumentationAPI: Add `MalformedComment` Aug 15, 2017

@damngamerz

This comment has been minimized.

Show comment
Hide comment
@damngamerz
Member

damngamerz commented Aug 16, 2017

For reference coala/coala-bears#2001

@SanketDG

Design good, please update docs and explain it now returns two types of objects in DocBaseClass.extract()

Show outdated Hide outdated coalib/bearlib/languages/documentation/DocumentationComment.py
Show outdated Hide outdated coalib/bearlib/languages/documentation/DocumentationComment.py
Show outdated Hide outdated coalib/bearlib/languages/documentation/DocumentationComment.py
Show outdated Hide outdated coalib/bearlib/languages/documentation/DocumentationExtraction.py
Show outdated Hide outdated tests/bearlib/languages/documentation/DocBaseClassTest.py
:param message:
Contains the message about the error.
:param line:
Contains the current line of the docstring where the error has

This comment has been minimized.

@SanketDG
@SanketDG
@SanketDG

This comment has been minimized.

Show comment
Hide comment
@SanketDG

SanketDG Aug 17, 2017

Member

ack c5da58e bd80892

Member

SanketDG commented Aug 17, 2017

ack c5da58e bd80892

@SanketDG

This comment has been minimized.

Show comment
Hide comment
@SanketDG

SanketDG Aug 17, 2017

Member

rebase and get it merged

Member

SanketDG commented Aug 17, 2017

rebase and get it merged

damngamerz added some commits Aug 11, 2017

Revert "DocBaseClass: Fix java docstyle bug"
This fix was inappropriate which broke all corner cases.
DocumentationAPI doesn't care about docstrings which have
faulty markers.
This reverts commit 5805f97.
DocumentationAPI: Add `MalformedComment`
`MalformedComment` is the new error handling mechanism
in DocumentationAPI. Which will help in yielding a
subsequent `RESULT` with a beautiful message in the bear.

Closes #4548
@gureks

This comment has been minimized.

Show comment
Hide comment
@gureks
Member

gureks commented Aug 17, 2017

@rultor

This comment has been minimized.

Show comment
Hide comment
@rultor

rultor Aug 17, 2017

Contributor

@rultor please merge

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

Contributor

rultor commented Aug 17, 2017

@rultor please merge

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

@rultor rultor merged commit 0f81583 into coala:master Aug 17, 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 This commit has no issues. :)
Details
review/gitmate/manual This commit was acknowledged.
Details
review/gitmate/pr This PR has no issues. :)
Details
@rultor

This comment has been minimized.

Show comment
Hide comment
@rultor

rultor Aug 17, 2017

Contributor

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

Contributor

rultor commented Aug 17, 2017

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

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