fix: parse docstring that come without summaries (#187)

* fix: parse docstring with no summary given

* test: update unit test for parsing docstring with no summary

Author: dandhlee

docfx_yaml/extension.py

@@ -582,8 +582,8 @@ def _extract_docstring_info(summary_info, summary, name):
     # if we found empty array for indexes, stop processing further.
     index = min(indexes) if indexes else 0
 
-    # Store the top summary separately.
-    if index == 0:
+    # Store the top summary separately. Ensure that the docstring is not empty.
+    if index == 0 and not indexes:
         return summary
 
     top_summary = parsed_text[:index]

tests/test_unit.py

@@ -431,6 +431,31 @@ def test_extract_docstring_info_with_xref(self):
         self.assertDictEqual(summary_info_got, summary_info_want)
 
 
+    def test_extract_docstring_info_no_summary(self):
+        ## Test parsing docstring with no summary.
+        summary =(
+"""Args:
+    arg1(int): simple description.
+    arg2(str): simple description for `arg2`.
+
+Returns:
+    str: simple description for return value.
+
+Raises:
+    AttributeError: if `condition x`.
+"""
+        )
+        summary_info_got = {
+            'variables': {},
+            'returns': [],
+            'exceptions': []
+        }
+
+        top_summary_got = _extract_docstring_info(summary_info_got, summary, "")
+        self.assertEqual(top_summary_got, "")
+        self.assertDictEqual(summary_info_got, self.summary_info1_want)
+
+
     def test_find_package_group(self):
         package_group_want = "google.cloud.spanner_v1beta2"
         uid = "google.cloud.spanner_v1beta2.services.admin_database_v1.types"