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

DocumentationStyleBear: Use DocBaseClass #1928

Merged
merged 2 commits into from Jul 22, 2017

Conversation

7 participants
@damngamerz
Member

damngamerz commented Jul 15, 2017

DocumentationStyleBear uses DocBaseClass.
Closes #1927

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!

@damngamerz

This comment has been minimized.

Member

damngamerz commented Jul 15, 2017

This should be merged after coala/coala#4465
Till then status blocked.

@sils sils added the status/blocked label Jul 15, 2017

@NiklasMM

Why are you not using the BaseClass through inheritance?

if main_description.desc == '\n' and not allow_missing_func_desc:
# Triple quoted string literals doesn't look good. It breaks
# the line of flow. Hence we use dedent.
self.warning_desc = dedent("""\

This comment has been minimized.

@NiklasMM

NiklasMM Jul 20, 2017

Contributor

Yes! 🎉

doc_comment.range.end.line,
doc_comment.range.end.column)
diff.replace(old_range, new_comment.assemble())
self.diff_generation(doc_comment, new_comment)

This comment has been minimized.

@NiklasMM

NiklasMM Jul 20, 2017

Contributor

Related to my comment in the other PR: The fact that you store the diff and affected code in a member during this call as a side effect makes it hard for a person reading this code to understand what's going on. I'd prefer it if the results would be returned.

@Nosferatul

This comment has been minimized.

Member

Nosferatul commented Jul 20, 2017

@damngamerz you don't need tests for the new functions?

@damngamerz

This comment has been minimized.

Member

damngamerz commented Jul 21, 2017

@Nosferatul Yup We don't need it,It's already there. Im just revamping the structure.

# Need to initialize them as some parts of extraction and
# diff_generation uses them.
self.file = file
self.filename = filename

This comment has been minimized.

@NiklasMM

NiklasMM Jul 21, 2017

Contributor

these two member assignments are not needed anymore, right?

This comment has been minimized.

@damngamerz

damngamerz Jul 21, 2017

Member

Yup^ amending the changes

doc_comment.range.end.line,
doc_comment.range.end.column)
diff.replace(old_range, new_comment.assemble())
(affected_code, diffs) = self.generate_diff(

This comment has been minimized.

@NiklasMM

NiklasMM Jul 21, 2017

Contributor

As I commented in the other PR, accept the plain Diff object from the generate_diff method and assemble the {"filename": <Diff>} object here in this method... makes it clearer what's going on

This comment has been minimized.

@damngamerz

damngamerz Jul 21, 2017

Member

Yeah we should do this 🎉

@SanketDG

This comment has been minimized.

Member

SanketDG commented Jul 22, 2017

ack 13f515d

"""
This fixes the parsed documentation comment.
:param parsed: Contains parsed documentation comment.

This comment has been minimized.

@SanketDG

SanketDG Jul 22, 2017

Member

put newlines after the param name

@SanketDG

This comment has been minimized.

Member

SanketDG commented Jul 22, 2017

DocumentationStyleBear: Use DocBaseClass
DocumentationStyleBear uses new DocumentationAPI
DocBaseClass.

Closes #1927
@SanketDG

This comment has been minimized.

Member

SanketDG commented Jul 22, 2017

reack 314dfdf

@SanketDG

This comment has been minimized.

Member

SanketDG commented Jul 22, 2017

@rultor merge

@rultor

This comment has been minimized.

rultor commented Jul 22, 2017

@rultor merge

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

@rultor rultor merged commit 314dfdf into coala:master Jul 22, 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

@damngamerz damngamerz deleted the damngamerz:docbaseclass branch Jul 22, 2017

@rultor

This comment has been minimized.

rultor commented Jul 22, 2017

@rultor merge

@SanketDG 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