Merge pull request #17 from parikshit14/bug/docstring

added comments for docstring parsing

Author: pgleeson

src/modelspec/base_types.py

@@ -373,6 +373,9 @@ def _parse_definition(cls) -> str:
         p = parse(cls.__doc__)
 
         # Extract the description, use the long description if available.
+        # "short_description" only parse the first non-empty line and
+        # "long_description" parse the rest of the docstring i.e.
+        # it skips the first non-empty line and parse the rest of the docstring
         if p.long_description:
             definition = f"{p.short_description} {p.long_description}"
         else: