Supported function type annotation comment (#15).

Author: takuya_sekiguchi

README.md

@@ -672,7 +672,7 @@ $ python ./run_all_tests_and_lint.py
 Command to run the entire test:
 
 ```
-$ pytest --cov=numdoclint tests/
+$ pytest --cov=numdoclint tests/ -v
 ```
 
 Command to run the autoflake:

numdoclint/helper.py

@@ -291,6 +291,8 @@ def get_func_overall_docstring(
         if index == 0:
             func_str += line_str
             continue
+        if _type_anotation_comment_exists(line_str=line_str):
+            continue
         if (('"""' in line_str or "'''" in line_str)
                 and (not is_docstring_line)):
             is_docstring_line = True
@@ -340,6 +342,25 @@ def get_func_overall_docstring(
     return docstring
 
 
+def _type_anotation_comment_exists(line_str):
+    """
+    Get a boolean value whether type annotation comment exists
+    in line or not.
+
+    Parameters
+    ----------
+    line_str : str
+        The target line string.
+
+    Returns
+    -------
+    result : bool
+        If exists, True will be set.
+    """
+    result = '# type: ' in line_str
+    return result
+
+
 def _get_func_match(py_module_str, func_name):
     """
     Get a Match object of search result of target function.

tests/test_helper.py

@@ -280,6 +280,13 @@ def sample_func_10(price):
 
 Sample docstring."""
     pass
+
+
+def sample_func_11(price):
+    # type: (int) -> None
+    """
+    Sample function with type annotation comment.
+    """
     '''
     docstring = helper.get_func_overall_docstring(
         py_module_str=py_module_str, func_name='sample_func_0')
@@ -380,6 +387,13 @@ def sample_func_10(price):
 Sample docstring."""
     assert docstring == expected_docstring
 
+    docstring = helper.get_func_overall_docstring(
+        py_module_str=py_module_str,
+        func_name='sample_func_11')
+    expected_docstring = \
+        """    Sample function with type annotation comment"""
+    assert docstring, expected_docstring
+
 
 def test__set_docstring_indent_number_to_one():
     docstring = """
@@ -1722,3 +1736,13 @@ def test__add_line_str():
     assert target_str == 'abc'
     target_str = helper._add_line_str(target_str='abc', line_str='def')
     assert target_str == 'abc\ndef'
+
+
+def test__type_anotation_comment_exists():
+    result = helper._type_anotation_comment_exists(
+        line_str='def sample_func():')
+    assert not result
+
+    result = helper._type_anotation_comment_exists(
+        line_str='    # type: (int) -> str')
+    assert result