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

Add DocumentationStyleBear #1506

Merged
merged 2 commits into from Jun 13, 2017

Conversation

@damngamerz
Member

damngamerz commented Mar 12, 2017

Continues #699

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.

Show comment
Hide comment
@damngamerz

damngamerz Mar 12, 2017

Member

Related to #699

Member

damngamerz commented Mar 12, 2017

Related to #699

@damngamerz

This comment has been minimized.

Show comment
Hide comment
@damngamerz

damngamerz Mar 12, 2017

Member

For reference 😄
coala --bears=DocumentationStyleBear --files=test.py -S allow_missing_func_desc=True -V --flush-cache
screenshot from 2017-03-12 20-36-08

Member

damngamerz commented Mar 12, 2017

For reference 😄
coala --bears=DocumentationStyleBear --files=test.py -S allow_missing_func_desc=True -V --flush-cache
screenshot from 2017-03-12 20-36-08

@jayvdb jayvdb changed the title from Add DocumentationStyleBear. to Add DocumentationStyleBear Mar 13, 2017

Show outdated Hide outdated bears/documentation/DocumentationStyleBear.py Outdated
Show outdated Hide outdated bears/documentation/DocumentationStyleBear.py Outdated
@NiklasMM

Found two minor grammatical errors.

Show outdated Hide outdated bears/documentation/DocumentationStyleBear.py Outdated
Show outdated Hide outdated bears/documentation/DocumentationStyleBear.py Outdated
@damngamerz

This comment has been minimized.

Show comment
Hide comment
@damngamerz

damngamerz Mar 13, 2017

Member

@NiklasMM Done! 👍 Thanks for pointing out those were legit mistakes.

Member

damngamerz commented Mar 13, 2017

@NiklasMM Done! 👍 Thanks for pointing out those were legit mistakes.

@jayvdb

This comment has been minimized.

Show comment
Hide comment
@jayvdb

jayvdb Mar 14, 2017

Member

Please also add tests for one-liners like """...""", and docstrings in the middle of a code block, both assigned (normal variables) and unassigned (i.e "attribute docstrings" and "additional docstrings").

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.

if True:
    class Foo:
        """..."""
        def __init__(self):
            """..."""
Member

jayvdb commented Mar 14, 2017

Please also add tests for one-liners like """...""", and docstrings in the middle of a code block, both assigned (normal variables) and unassigned (i.e "attribute docstrings" and "additional docstrings").

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.

if True:
    class Foo:
        """..."""
        def __init__(self):
            """..."""
@damngamerz

This comment has been minimized.

Show comment
Hide comment
@damngamerz

damngamerz Apr 4, 2017

Member

@jayvdb one line documentation test-case is included in bad_file2 and classes, func test case is included in bad_file3. if case will not make a difference, as we are extracting all documentation strings from a file.

Member

damngamerz commented Apr 4, 2017

@jayvdb one line documentation test-case is included in bad_file2 and classes, func test case is included in bad_file3. if case will not make a difference, as we are extracting all documentation strings from a file.

@jayvdb

still missing

  • class one-liner docstring.
  • if indented 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.

@damngamerz

This comment has been minimized.

Show comment
Hide comment
@damngamerz

damngamerz Apr 15, 2017

Member

@jayvdb Can you explain me with an example how allow_missing_func_desc will work? I need to get this merged before release freeze. Also i would like mention that only the basic functionality of DocumentationStyleBear(discussed with @SanketDG ) should be merged(along with the tests you mentioned of course :) ), there are many changes which are needed to be done in Documentation API in order to solve the issues mentioned by you and also mentioned over here http://projects.coala.io/#/projects?project=documentation_extraction_and_parsing
(one of the reason why this is important to be merged before release freeze) need your help to get this merged ASAP.

Member

damngamerz commented Apr 15, 2017

@jayvdb Can you explain me with an example how allow_missing_func_desc will work? I need to get this merged before release freeze. Also i would like mention that only the basic functionality of DocumentationStyleBear(discussed with @SanketDG ) should be merged(along with the tests you mentioned of course :) ), there are many changes which are needed to be done in Documentation API in order to solve the issues mentioned by you and also mentioned over here http://projects.coala.io/#/projects?project=documentation_extraction_and_parsing
(one of the reason why this is important to be merged before release freeze) need your help to get this merged ASAP.

@gitmate-bot

This comment has been minimized.

Show comment
Hide comment
@gitmate-bot

gitmate-bot May 14, 2017

Collaborator

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

Collaborator

gitmate-bot commented May 14, 2017

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

Show outdated Hide outdated bears/documentation/DocumentationStyleBear.py Outdated
new_comment = DocumentationComment.from_metadata(
new_metadata, doc_comment.docstyle_definition,
doc_comment.marker, doc_comment.indent, doc_comment.range)

This comment has been minimized.

@jayvdb

jayvdb Jun 10, 2017

Member

doc_comment.indent appears to be guessed at https://github.com/coala/coala/blob/master/coalib/bearlib/languages/documentation/DocumentationExtraction.py#L190 .

Again, this really should be determine by the user setting indent_size , if the user specified it , which would need to be passed into the extract_documentation() invocation. But it would be a very low priority bug, as guessing is probably going to work well in most cases. Could you take a quick look though this, confirm my suspicions, and raise a bug in coala/coala if I am correct. It doesnt need to be solved for this bear, but we do need to know the potential bugs.

@jayvdb

jayvdb Jun 10, 2017

Member

doc_comment.indent appears to be guessed at https://github.com/coala/coala/blob/master/coalib/bearlib/languages/documentation/DocumentationExtraction.py#L190 .

Again, this really should be determine by the user setting indent_size , if the user specified it , which would need to be passed into the extract_documentation() invocation. But it would be a very low priority bug, as guessing is probably going to work well in most cases. Could you take a quick look though this, confirm my suspicions, and raise a bug in coala/coala if I am correct. It doesnt need to be solved for this bear, but we do need to know the potential bugs.

This comment has been minimized.

@damngamerz

damngamerz Jun 12, 2017

Member

Alright i got it what you want to say. But there needs some clarification, doc_comment.indent what it actually stores is

def case1():
    """
    It stores docstring indent space below starting marker, as in this case it is 4.
    """

what that literal 4 is for.

def case2(xyz):
    """
    This is case docstring.

    :param xyz:
        here 4 spaces in param desc, along with doc_comment.indent
        this 4 spaces is represented by literal 4

    """

Hence you can see the literal 4 is used for linting purpose and hence it should be hardcoded.
Now the question is do we really need a different setting so as to specify that indent space for params, exceptions and return descriptions? If yes this PR can be closed and I will create a seperate Issue for that.

@damngamerz

damngamerz Jun 12, 2017

Member

Alright i got it what you want to say. But there needs some clarification, doc_comment.indent what it actually stores is

def case1():
    """
    It stores docstring indent space below starting marker, as in this case it is 4.
    """

what that literal 4 is for.

def case2(xyz):
    """
    This is case docstring.

    :param xyz:
        here 4 spaces in param desc, along with doc_comment.indent
        this 4 spaces is represented by literal 4

    """

Hence you can see the literal 4 is used for linting purpose and hence it should be hardcoded.
Now the question is do we really need a different setting so as to specify that indent space for params, exceptions and return descriptions? If yes this PR can be closed and I will create a seperate Issue for that.

This comment has been minimized.

@jayvdb

jayvdb Jun 12, 2017

Member

indent size is indent size!

here 4 spaces in param desc is indented. It is indented by the same indent size that is used everywhere else.

yes, there are crazy people who will want different parts of their code indented at magically different levels, but that is unlikely to be something coala will ever support. What coala does support is one indent_size, chosen by the user , which is the size that should be used everywhere an indent is expected. If a user asks for indent_size = 2, that should be the indent size everywhere in the selected files. Anywhere it doesnt work is a bug.

We also support use_spaces = False, which I believe also doesnt work, and so far this PR doesnt have any tests for, but I have given up on that.

@jayvdb

jayvdb Jun 12, 2017

Member

indent size is indent size!

here 4 spaces in param desc is indented. It is indented by the same indent size that is used everywhere else.

yes, there are crazy people who will want different parts of their code indented at magically different levels, but that is unlikely to be something coala will ever support. What coala does support is one indent_size, chosen by the user , which is the size that should be used everywhere an indent is expected. If a user asks for indent_size = 2, that should be the indent size everywhere in the selected files. Anywhere it doesnt work is a bug.

We also support use_spaces = False, which I believe also doesnt work, and so far this PR doesnt have any tests for, but I have given up on that.

This comment has been minimized.

@jayvdb

jayvdb Jun 12, 2017

Member

And just in case it isnt clear, do not close this PR!
You need to understand indents and tabs, otherwise your project is doomed. Talk to your mentors if you are not understanding me.
Either fix the bugs, or raise them as separate issues to be fixed later.

@jayvdb

jayvdb Jun 12, 2017

Member

And just in case it isnt clear, do not close this PR!
You need to understand indents and tabs, otherwise your project is doomed. Talk to your mentors if you are not understanding me.
Either fix the bugs, or raise them as separate issues to be fixed later.

@jayvdb

jayvdb approved these changes Jun 13, 2017

Still some problems with indent size and tabs, but at least indent_size is now a setting, and the most obvious problem is fixed, so further issues can be raised separately as bugs.

@jayvdb

This comment has been minimized.

Show comment
Hide comment
@jayvdb
Member

jayvdb commented Jun 13, 2017

@jayvdb

This comment has been minimized.

Show comment
Hide comment
@jayvdb

jayvdb Jun 13, 2017

Member

@rultor merge

Member

jayvdb commented Jun 13, 2017

@rultor merge

@rultor

This comment has been minimized.

Show comment
Hide comment
@rultor

rultor Jun 13, 2017

@rultor merge

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

rultor commented Jun 13, 2017

@rultor merge

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

@rultor

This comment has been minimized.

Show comment
Hide comment
@rultor

rultor Jun 13, 2017

@rultor merge

@damngamerz @jayvdb Oops, I failed. You can see the full log here (spent 2min)

 * [new branch]      Makman2/docproto -> fork/Makman2/docproto
 * [new branch]      Makman2/gitcom-issues -> fork/Makman2/gitcom-issues
 * [new branch]      Makman2/postcss -> fork/Makman2/postcss
 * [new branch]      Makman2/testing-crosstest -> fork/Makman2/testing-crosstest
 * [new branch]      Makman2/tmp -> fork/Makman2/tmp
 * [new branch]      abhsag/linebreak -> fork/abhsag/linebreak
 * [new branch]      docformatbear -> fork/docformatbear
 * [new branch]      fixannot   -> fork/fixannot
 * [new branch]      hypothesist/wip -> fork/hypothesist/wip
 * [new branch]      jayvdb-rm-espeak -> fork/jayvdb-rm-espeak
 * [new branch]      master     -> fork/master
 * [new branch]      phpstan-b  -> fork/phpstan-b
 * [new branch]      red/extend-upload-tool -> fork/red/extend-upload-tool
 * [new branch]      release/0.1 -> fork/release/0.1
 * [new branch]      release/0.10 -> fork/release/0.10
 * [new branch]      release/0.2 -> fork/release/0.2
 * [new branch]      release/0.7 -> fork/release/0.7
 * [new branch]      release/0.8 -> fork/release/0.8
 * [new branch]      release/0.9 -> fork/release/0.9
 * [new branch]      sanketdg/docextration/capitalizebear -> fork/sanketdg/docextration/capitalizebear
 * [new branch]      sanketdg/docformatbear -> fork/sanketdg/docformatbear
 * [new branch]      sils/bfx   -> fork/sils/bfx
 * [new branch]      sils/infer -> fork/sils/infer
 * [new branch]      sils/lc    -> fork/sils/lc
 * [new branch]      sils/linters -> fork/sils/linters
 * [new branch]      sils/pmd   -> fork/sils/pmd
 * [new branch]      sils/quotes -> fork/sils/quotes
 * [new branch]      sils/revden -> fork/sils/revden
 * [new branch]      sils/sec   -> fork/sils/sec
 * [new branch]      sils/tailor -> fork/sils/tailor
 * [new branch]      sils/tailorbackport -> fork/sils/tailorbackport
 * [new branch]      sils/upgcoala -> fork/sils/upgcoala
 * [new branch]      sils/yapf-old -> fork/sils/yapf-old
 * [new branch]      underyx/go-caching -> fork/underyx/go-caching
 * [new branch]      underyx/req-version-specs -> fork/underyx/req-version-specs
 * [new branch]      upgrade    -> fork/upgrade
 * [new branch]      upgrade-yamllint -> fork/upgrade-yamllint
+ args=
+ '[' only == default ']'
+ '[' only == no ']'
+ '[' only == only ']'
+ args=' --ff-only'
+ export BRANCH=__rultor
+ BRANCH=__rultor
++ git show-branch __rultor
++ wc -l
+ '[' 0 -gt 0 ']'
+ git checkout -B __rultor fork/docformatbear
Switched to a new branch '__rultor'
Branch __rultor set up to track remote branch docformatbear from fork.
+ git checkout -B master origin/master
Switched to and reset branch 'master'
Branch master set up to track remote branch master from origin.
Your branch is up-to-date with 'origin/master'.
+ '[' false == true ']'
+ '[' false == true ']'
+ git merge --ff-only __rultor
fatal: Not possible to fast-forward, aborting.
'cid' file is absent, container wasn't started correctly

rultor commented Jun 13, 2017

@rultor merge

@damngamerz @jayvdb Oops, I failed. You can see the full log here (spent 2min)

 * [new branch]      Makman2/docproto -> fork/Makman2/docproto
 * [new branch]      Makman2/gitcom-issues -> fork/Makman2/gitcom-issues
 * [new branch]      Makman2/postcss -> fork/Makman2/postcss
 * [new branch]      Makman2/testing-crosstest -> fork/Makman2/testing-crosstest
 * [new branch]      Makman2/tmp -> fork/Makman2/tmp
 * [new branch]      abhsag/linebreak -> fork/abhsag/linebreak
 * [new branch]      docformatbear -> fork/docformatbear
 * [new branch]      fixannot   -> fork/fixannot
 * [new branch]      hypothesist/wip -> fork/hypothesist/wip
 * [new branch]      jayvdb-rm-espeak -> fork/jayvdb-rm-espeak
 * [new branch]      master     -> fork/master
 * [new branch]      phpstan-b  -> fork/phpstan-b
 * [new branch]      red/extend-upload-tool -> fork/red/extend-upload-tool
 * [new branch]      release/0.1 -> fork/release/0.1
 * [new branch]      release/0.10 -> fork/release/0.10
 * [new branch]      release/0.2 -> fork/release/0.2
 * [new branch]      release/0.7 -> fork/release/0.7
 * [new branch]      release/0.8 -> fork/release/0.8
 * [new branch]      release/0.9 -> fork/release/0.9
 * [new branch]      sanketdg/docextration/capitalizebear -> fork/sanketdg/docextration/capitalizebear
 * [new branch]      sanketdg/docformatbear -> fork/sanketdg/docformatbear
 * [new branch]      sils/bfx   -> fork/sils/bfx
 * [new branch]      sils/infer -> fork/sils/infer
 * [new branch]      sils/lc    -> fork/sils/lc
 * [new branch]      sils/linters -> fork/sils/linters
 * [new branch]      sils/pmd   -> fork/sils/pmd
 * [new branch]      sils/quotes -> fork/sils/quotes
 * [new branch]      sils/revden -> fork/sils/revden
 * [new branch]      sils/sec   -> fork/sils/sec
 * [new branch]      sils/tailor -> fork/sils/tailor
 * [new branch]      sils/tailorbackport -> fork/sils/tailorbackport
 * [new branch]      sils/upgcoala -> fork/sils/upgcoala
 * [new branch]      sils/yapf-old -> fork/sils/yapf-old
 * [new branch]      underyx/go-caching -> fork/underyx/go-caching
 * [new branch]      underyx/req-version-specs -> fork/underyx/req-version-specs
 * [new branch]      upgrade    -> fork/upgrade
 * [new branch]      upgrade-yamllint -> fork/upgrade-yamllint
+ args=
+ '[' only == default ']'
+ '[' only == no ']'
+ '[' only == only ']'
+ args=' --ff-only'
+ export BRANCH=__rultor
+ BRANCH=__rultor
++ git show-branch __rultor
++ wc -l
+ '[' 0 -gt 0 ']'
+ git checkout -B __rultor fork/docformatbear
Switched to a new branch '__rultor'
Branch __rultor set up to track remote branch docformatbear from fork.
+ git checkout -B master origin/master
Switched to and reset branch 'master'
Branch master set up to track remote branch master from origin.
Your branch is up-to-date with 'origin/master'.
+ '[' false == true ']'
+ '[' false == true ']'
+ git merge --ff-only __rultor
fatal: Not possible to fast-forward, aborting.
'cid' file is absent, container wasn't started correctly

SanketDG and others added some commits Aug 17, 2016

Add DocumentationStyleBear for doc styles
This bear checks the documentation comments in the given file
against a particular style.
Add allow_missing_func_desc
when this option in set to ``True``
this will ignore the warning.
Allowing docstrings to start with params.
Add setting ``indent_size``.
Add subsequent test case.
@meetmangukiya

This comment has been minimized.

Show comment
Hide comment
@meetmangukiya
Member

meetmangukiya commented Jun 13, 2017

@meetmangukiya

This comment has been minimized.

Show comment
Hide comment
@meetmangukiya
Member

meetmangukiya commented Jun 13, 2017

@rultor merge

@rultor

This comment has been minimized.

Show comment
Hide comment
@rultor

rultor Jun 13, 2017

@rultor merge

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

rultor commented Jun 13, 2017

@rultor merge

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

@rultor rultor merged commit 7ad62fb into coala:master Jun 13, 2017

6 of 8 checks passed

ci/circleci CircleCI is running your tests
Details
continuous-integration/appveyor/branch Waiting for AppVeyor build to complete
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
@rultor

This comment has been minimized.

Show comment
Hide comment
@rultor

rultor Jun 13, 2017

@rultor merge

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

rultor commented Jun 13, 2017

@rultor merge

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

@damngamerz damngamerz deleted the damngamerz:docformatbear branch Jun 13, 2017

@lucas03

This comment has been minimized.

Show comment
Hide comment
@lucas03

lucas03 Jun 15, 2017

Hi, I was trying this bear few days ago. These two changes were a problematic:

|  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 = """

and also one liners:

|  46|    |-    """Endpoints for partner handling."""
|    |  46|+    """
|    |  47|+    Endpoints for partner handling.
|    |  48|+    """

lucas03 commented Jun 15, 2017

Hi, I was trying this bear few days ago. These two changes were a problematic:

|  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 = """

and also one liners:

|  46|    |-    """Endpoints for partner handling."""
|    |  46|+    """
|    |  47|+    Endpoints for partner handling.
|    |  48|+    """
@damngamerz

This comment has been minimized.

Show comment
Hide comment
@damngamerz

damngamerz Jun 15, 2017

Member

@lucas03 This is still WIP. one-liners as accepted in PEP-257 are not being accepted by DocStyleBear yet. Althought Im not sure about the 1st case its a fancy string which is right now also not supported. Look
coala/coala#4291

Member

damngamerz commented Jun 15, 2017

@lucas03 This is still WIP. one-liners as accepted in PEP-257 are not being accepted by DocStyleBear yet. Althought Im not sure about the 1st case its a fancy string which is right now also not supported. Look
coala/coala#4291

@Makman2

This comment has been minimized.

Show comment
Hide comment
@Makman2

Makman2 Jun 15, 2017

Member

We should have a setting to expand one-liners or not. Actually I prefer not using one-liners, because the preceding """ look quite ugly imo and don't make the docstring look like one :3
Especially as this bear shall once work on the coala repo, we need a switch for that 👍

Member

Makman2 commented Jun 15, 2017

We should have a setting to expand one-liners or not. Actually I prefer not using one-liners, because the preceding """ look quite ugly imo and don't make the docstring look like one :3
Especially as this bear shall once work on the coala repo, we need a switch for that 👍

@userzimmermann

This comment has been minimized.

Show comment
Hide comment
@userzimmermann

userzimmermann Jun 18, 2017

Member

@lucas03 @damngamerz @Makman2 But this example from #1506 (comment) is really a serious issue:

|  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

cc @jayvdb @NiklasMM @meetmangukiya @hemangsk

Member

userzimmermann commented Jun 18, 2017

@lucas03 @damngamerz @Makman2 But this example from #1506 (comment) is really a serious issue:

|  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

cc @jayvdb @NiklasMM @meetmangukiya @hemangsk

@Makman2

This comment has been minimized.

Show comment
Hide comment
@Makman2

Makman2 Jun 18, 2017

Member

Maybe we need to make the assumption that a docstring must not have any code standing before, so just whitespaces are allowed^^

Member

Makman2 commented Jun 18, 2017

Maybe we need to make the assumption that a docstring must not have any code standing before, so just whitespaces are allowed^^

@jayvdb

This comment has been minimized.

Show comment
Hide comment
@jayvdb

jayvdb Jun 18, 2017

Member

Please create new issues for all of these and more.
There are lots of situations and 'styles' that this bear doesnt yet cover.

Member

jayvdb commented Jun 18, 2017

Please create new issues for all of these and more.
There are lots of situations and 'styles' that this bear doesnt yet cover.

@damngamerz

This comment has been minimized.

Show comment
Hide comment
@damngamerz

damngamerz Jun 19, 2017

Member

@jayvdb @Makman2 @userzimmermann @lucas03 cool created issues...
#1856 Adding a setting for the expansion of one-liners
#4291 Handling fancy strings.
We can continue discussions there. If you find any issues. feel free to ping me up 😄

Member

damngamerz commented Jun 19, 2017

@jayvdb @Makman2 @userzimmermann @lucas03 cool created issues...
#1856 Adding a setting for the expansion of one-liners
#4291 Handling fancy strings.
We can continue discussions there. If you find any issues. feel free to ping me up 😄

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