Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Add DocumentationStyleBear #1506
For short term contributors: we understand that getting your commits well
After you submit your pull request, DO NOT click the 'Update Branch' button.
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
referenced this pull request
Mar 13, 2017
Please also add tests for one-liners like
Currently there are no test cases for classes & methods. Could you quickly check whether they work. If they dont, and it isnt easy to fix, let's declare them out of scope, and actively prevent them being modified.
Also need to check funcs and classes within if block i.e.
- class one-liner docstring.
ifindented func & class.
- inner functions
These may not seen different from your existing tests. So they should be very easy to write, and they ensure that there are not any unexpected bugs, and ensure that future re-implementations dont break these corner cases.
@jayvdb Can you explain me with an example how
Jun 13, 2017
6 of 8 checks passed
Hi, I was trying this bear few days ago. These two changes were a problematic:
and also one liners:
We should have a setting to expand one-liners or not. Actually I prefer not using one-liners, because the preceding
| 27| 27| def save(data, **kw): | 28| |- sql = """INSERT INTO data (order_id, invoice_link, ...) | 29| |- VALUES (%(order_id)s, %(invoice_link)s, ...)""" | | 28|+ sql = """ | | 29|+ sql = INSERT INTO failed_exponea (order_id, invoice_link, ...) | | 30|+ sql = (%(order_id)s, %(invoice_link)s, ...) | | 31|+ sql = """
Especially since it's not really a docstring att all :/ How to deal with that?
Maybe this PR was merged too early... So we have to quickly see how to further improve it accordingly