Skip to content

Commit

Permalink
DocumentationStyleBear: Corrects generated patch
Browse files Browse the repository at this point in the history
This removes the extra 'r' added in raw docstrings
in generated patch in python by DocumentationStyleBear.

Fixes coala#2010
  • Loading branch information
kriti21 committed Mar 4, 2018
1 parent b0b5560 commit 51586e7
Show file tree
Hide file tree
Showing 4 changed files with 133 additions and 0 deletions.
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# NOTE: This file is parsed by .ci/generate_bear_requirements.py
# Use >= for development versions so that source builds always work
coala>=0.12.0.dev20170828055500
-e git+https://github.com/kriti21/coala.git#egg=b62f5a98da19cb99a429a32e194d002e9947fc87
# Dependencies inherited from coala
# libclang-py3
# coala_utils
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
def docstring_missing_description(dummy):
r"""
:param dummy:dummy description
:return:nothing"""
return None


class docstring_class_testcase(dummy):
r"""
Example raw docstring class.
:param dummy:dummy description
:return:nothing
"""

def docstring_memberfunction(self, dummy):
r'''
This is a member function.
:param dummy:dummy description
:return:nothing
'''
return None
return None


class docstring_if_indented():
r'''This is if indented function example.'''

if 1 != 0:
def hello_planet(self):
r"""
This is `if` indented block function.
"""
return None
else:
def hello_venus(self):
r"""This is `if` indented block function."""
return None


def docstring_inner_function(dummy):
r'''
This is docstring inner function example.
:param dummy: dummy description
'''
def check_directory(dummy):
r"""
This is the inner function.
:param dummy: dummy description
:return: nothing
"""
return None
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
def docstring_missing_description(dummy):
r"""
:param dummy:
dummy description
:return:
nothing
"""
return None


class docstring_class_testcase(dummy):
r"""
Example docstring class.

:param dummy:
dummy description
:return:
nothing
"""

def docstring_memberfunction(self, dummy):
r'''
This is a member function.

:param dummy:
dummy description
:return:
nothing
'''
return None
return None


class docstring_if_indented():
r'''
This is if indented function example.
'''

if 1 != 0:
def hello_planet(self):
r"""
This is `if` indented block function.
"""
return None
else:
def hello_venus(self):
r"""
This is `if` indented block function.
"""
return None


def docstring_inner_function(dummy):
r'''
This is docstring inner function example.

:param dummy:
dummy description
'''
def check_directory(dummy):
r"""
This is the inner function.

:param dummy:
dummy description
:return:
nothing
"""
return None
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
def docstring_accepted(dummy):
r"""
This is the accepted standard of a docstring.

:param dummy:
first line description
second line description
:return:
first line description
second line description
"""
return None

0 comments on commit 51586e7

Please sign in to comment.