Skip to content

Commit

Permalink
DocumentationStyleBear.py: Change docstring format
Browse files Browse the repository at this point in the history
Improve the indentation of docstring in function
run().

Closes coala#1941
  • Loading branch information
vedantc98 committed Dec 21, 2017
1 parent 331c365 commit 6f05d32
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions bears/documentation/DocumentationStyleBear.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,16 +141,21 @@ def run(self, filename, file, language: str,
also 4 space indent
following lines are also 4 space indented
:param language: The programming language of the file(s).
:param docstyle: The docstyle to use. For example ``default`` or
``doxygen``. Docstyles are language dependent, meaning
not every language is supported by a certain docstyle.
:param allow_missing_func_desc: When set ``True`` this will allow
functions with missing descriptions, allowing
functions to start with params.
:param indent_size: Number of spaces per indentation level.
:param expand_one_liners: When set ``True`` this will expand one liner
docstrings.
:param language:
The programming language of the file(s).
:param docstyle:
The docstyle to use. For example ``default`` or
``doxygen``. Docstyles are language dependent, meaning
not every language is supported by a certain docstyle.
:param allow_missing_func_desc:
When set ``True`` this will allow
functions with missing descriptions, allowing
functions to start with params.
:param indent_size:
Number of spaces per indentation level.
:param expand_one_liners:
When set ``True`` this will expand one liner
docstrings.
"""

for doc_comment in self.extract(file, language, docstyle):
Expand Down

0 comments on commit 6f05d32

Please sign in to comment.