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

DocStyleBear should also check for <blank line> before and after the DocString. #4200

Closed
damngamerz opened this Issue May 8, 2017 · 0 comments

Comments

1 participant
@damngamerz
Member

damngamerz commented May 8, 2017

The current implementation DocStyleBear violates PEP-257. There’s no function to check a blank line either or before the docstrings. Implement a functionality which basically checks for a blank line before and after a docstring, and if it doesn’t comply to it, generate a proper fix.

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Jul 23, 2017

DocumentationStyleBear: Add blankline check
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Closes coala/coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Jul 23, 2017

DocumentationStyleBear: Add blankline check
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Closes coala/coala#4200

@damngamerz damngamerz referenced this issue Jul 23, 2017

Merged

DocumentationStyleBear: Add blankline check #1943

2 of 2 tasks complete

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Jul 23, 2017

DocumentationStyleBear: Add blankline check
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Closes coala/coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Jul 23, 2017

DocumentationStyleBear: Add blankline check
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Closes coala/coala#4200

damngamerz added a commit to damngamerz/coala that referenced this issue Jul 24, 2017

DocumentationComment.py: Add blankline padding
`assemble()` now adds a blank line before or after
docstring based on top_padding and bottom_padding.

Closes coala#4200

@rultor rultor closed this in #4549 Jul 24, 2017

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Jul 24, 2017

DocumentationStyleBear: Add blankline check
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Jul 24, 2017

DocumentationStyleBear: Add blankline check
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Jul 24, 2017

DocumentationStyleBear: Add blankline check
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Jul 24, 2017

DocumentationStyleBear: Add blankline check
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

@damngamerz damngamerz referenced this issue Jul 25, 2017

Merged

DocumentationAPI: Add `padding` #4557

2 of 2 tasks complete

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Jul 25, 2017

DocumentationStyleBear: Add blankline support
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Jul 25, 2017

DocumentationStyleBear: Add blankline support
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Aug 14, 2017

DocumentationStyleBear: Add blankline support
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Aug 17, 2017

DocumentationStyleBear: Add blankline support
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

damngamerz added a commit to damngamerz/coala that referenced this issue Aug 18, 2017

DocumentationAPI: Add `padding` and `type`
Add `class_padding`, `function_padding` and
`docstring_position` in DocstyleDefinition
which are now acquired from `.coalang`. Add
`top_padding` and `bottom_padding` which is
automatically instantiated from
DocumentationExtraction. Add `docstring_type` in
DocumentationComment which will automatically
determine the type of docstring from
DocumentationExtraction. Add supporting test
cases.

Related to coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Aug 18, 2017

DocumentationStyleBear: Add blankline support
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Aug 18, 2017

DocumentationStyleBear: Add blankline support
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

damngamerz added a commit to damngamerz/coala-bears that referenced this issue Aug 19, 2017

DocumentationStyleBear: Add blankline support
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200

umeshksingla added a commit to umeshksingla/coala-bears that referenced this issue Sep 2, 2017

DocumentationStyleBear: Add blankline support
DocumentationStyleBear now checks for blankline
before and after the docstring and fixes them.

Related to coala/coala#4200
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment