DocumentationAPI: Add MalformedComment
#4637
Merged
Conversation
This file contains 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
|
looks good to me 👍 |
damngamerz
force-pushed
the
raiselog
branch
3 times, most recently
from
2c0fac6 to
a84dc8d
Compare
damngamerz
changed the title
MalformedComment
|
For reference coala/coala-bears#2001 |
damngamerz
force-pushed
the
raiselog
branch
2 times, most recently
from
147bc90 to
c931457
Compare
SanketDG
requested changes
Aug 16, 2017
| def __init__(self, message): | ||
| """ | ||
| Instantiate a MalformedComment, which contains the information about | ||
| the errors generated by DocumentationAPI. |
There was a problem hiding this comment.
DocumentationAPI is a very internal term, explain on this, don't use this term
| :param message: | ||
| Contains the message about the error. | ||
| :param line: | ||
| Contains the related line no. |
| def __init__(self, message, line): | ||
| """ | ||
| Instantiate a MalformedComment, which contains the information about | ||
| the errors generated by DocumentationAPI. |
There was a problem hiding this comment.
DocumentationAPI is a very internal term, explain this
| if doc_comment: | ||
| return end_line, end_column, doc | ||
| else: | ||
| doc = MalformedComment(dedent("""\ |
There was a problem hiding this comment.
doc? that's a bad variable name :P
| self.assertEqual( | ||
| [doc_comment.message, doc_comment.line], | ||
| [dedent("""\ | ||
| Please check the docstring for faulty markers. A starting |
There was a problem hiding this comment.
store the string already in a variable :P
damngamerz
force-pushed
the
raiselog
branch
4 times, most recently
from
81ed786 to
bd80892
Compare
SanketDG
reviewed
Aug 17, 2017
| :param message: | ||
| Contains the message about the error. | ||
| :param line: | ||
| Contains the current line of the docstring where the error has |
|
ack c5da58e bd80892 |
SanketDG
approved these changes
Aug 17, 2017
|
rebase and get it merged |
SanketDG
added
process/approved
This fix was inappropriate which broke all corner cases. DocumentationAPI doesn't care about docstrings which have faulty markers. This reverts commit 5805f97.
`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 coala#4548
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.
MalformedCommentis the new error handling mechanismin DocumentationAPI. Which will help in yielding a
subsequent
RESULTwith 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
them.
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:
cobot mark wip <URL>to get it outof the review queue.
The more you review, the more your score will grow at coala.io and we will
review your PRs faster!