DocformatterBear: Add DocformatterBear #1556

satwikkansal · 2017-03-28T09:31:21Z

A python bear that wraps the executable "docformatter".

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:

pick up any PR at https://coala.io/review
review it (check https://coala.io/reviewing for more info)
if you are sure that it needs work, use cobot mark wip <URL> to get it out
of the review queue.

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

satwikkansal · 2017-03-28T18:22:18Z

tests/python/DocformatterBearTest.py

+
+from bears.python.DocformatterBear import DocformatterBear
+from coalib.testing.LocalBearTestHelper import LocalBearTestHelper
+from coalib.results.Result import RESULT_SEVERITY, Result


Unused imports, to be removed.

A python bear that wraps the executable "docformatter". Closes #1326

satwikkansal · 2017-04-01T18:47:15Z

Working in my local computer

As it uses unified_diff output format, Will be ready to merge once coala/coala#3739 is merged.

jayvdb

I think this should wait until #1506 is merged and use the test files created there, or ... this PR needs a lot more tests that verifies these options. Esp. for example the line length wrap arguments should check if it needs to be 79 or 80 in order to match the behaviour of line maximum settings in other bears.

jayvdb · 2017-04-06T18:16:00Z

bears/python/DocformatterBear.py

+
+    @staticmethod
+    def create_arguments(filename, file, config_file,
+                         wrap_summaries_length: int=79,


80 is defined in coala's repo SpacingHelper iirc.

Also shouldnt this default to the value of max_line_length

jayvdb · 2017-04-06T18:20:55Z

bears/python/DocformatterBear.py

+    @staticmethod
+    def create_arguments(filename, file, config_file,
+                         wrap_summaries_length: int=79,
+                         wrap_descriptions_length: int=72,


if 72 is relative to 79, then this default should be None, and then it can be calculated by default as relative to whatever the value of setting wrap_summaries_length is chosen by the user.

"79" and "72" were the default values specified in docformatter's documentation. Actually, I was not aware if we used coala-provided defaults or the defaults for the external linter that the bear wraps 😅

gitmate-bot · 2017-04-13T18:00:15Z