Merge branch 'parikshit14-bug/docstring' into development

Author: pgleeson

examples/document.md

@@ -1,5 +1,5 @@
 ## Document
-A model for documents
+A model for documents.
 
 ### Allowed parameters
 <table>
@@ -38,7 +38,7 @@ A model for documents
 </table>
 
 ## Section
-Will contain one <a href="#paragraph">Paragraph</a> or more.
+A model of a section of the <a href="#document">Document</a>. Will contain one <a href="#paragraph">Paragraph</a> or more.
 
 ### Allowed parameters
 <table>
@@ -63,7 +63,7 @@ Will contain one <a href="#paragraph">Paragraph</a> or more.
 </table>
 
 ## Paragraph
-A model of a paragraph
+A model of a paragraph.
 
 ### Allowed parameters
 <table>

examples/document.py

@@ -9,7 +9,7 @@
 @modelspec.define
 class Paragraph(Base):
     """
-    A model of a paragraph
+    A model of a paragraph.
 
     Args:
         contents: Paragraph contents, which make up the _Section_s.
@@ -36,7 +36,7 @@ class Section(Base):
 @modelspec.define
 class Document(Base):
     """
-    A model for documents
+    A model for documents.
 
     Args:
         id: The unique id of the document

examples/document.rst

@@ -1,7 +1,7 @@
 ========
 Document
 ========
-A model for documents
+A model for documents.
 
 **Allowed parameters**
 
@@ -24,7 +24,7 @@ Allowed child    Data Type              Description
 =======
 Section
 =======
-Will contain one <a href="#paragraph">Paragraph</a> or more.
+A model of a section of the <a href="#document">Document</a>. Will contain one <a href="#paragraph">Paragraph</a> or more.
 
 **Allowed parameters**
 
@@ -45,7 +45,7 @@ Allowed child    Data Type                  Description
 =========
 Paragraph
 =========
-A model of a paragraph
+A model of a paragraph.
 
 **Allowed parameters**
 

examples/document.specification.json

@@ -1,6 +1,6 @@
 {
     "Document": {
-        "definition": "A model for documents",
+        "definition": "A model for documents.",
         "allowed_parameters": {
             "id": {
                 "type": "str",
@@ -23,7 +23,7 @@
         }
     },
     "Section": {
-        "definition": "Will contain one :class:`Paragraph` or more.",
+        "definition": "A model of a section of the :class:`Document`. Will contain one :class:`Paragraph` or more.",
         "allowed_parameters": {
             "id": {
                 "type": "str",
@@ -38,7 +38,7 @@
         }
     },
     "Paragraph": {
-        "definition": "A model of a paragraph",
+        "definition": "A model of a paragraph.",
         "allowed_parameters": {
             "contents": {
                 "type": "str",

examples/document.specification.yaml

@@ -1,5 +1,5 @@
 Document:
-    definition: A model for documents
+    definition: A model for documents.
     allowed_parameters:
         id:
             type: str
@@ -15,7 +15,8 @@ Document:
             type: Section
             description: The sections of the document
 Section:
-    definition: Will contain one :class:`Paragraph` or more.
+    definition: A model of a section of the :class:`Document`. Will contain one :class:`Paragraph`
+        or more.
     allowed_parameters:
         id:
             type: str
@@ -25,7 +26,7 @@ Section:
             type: Paragraph
             description: The paragraphs
 Paragraph:
-    definition: A model of a paragraph
+    definition: A model of a paragraph.
     allowed_parameters:
         contents:
             type: str

src/modelspec/base_types.py

@@ -373,7 +373,11 @@ def _parse_definition(cls) -> str:
         p = parse(cls.__doc__)
 
         # Extract the description, use the long description if available.
-        return p.long_description if p.long_description else p.short_description
+        if p.long_description:
+            definition = f"{p.short_description} {p.long_description}"
+        else:
+            definition = p.short_description
+        return definition
 
     @classmethod
     def _parse_allowed_fields(cls) -> Dict[str, Tuple[str, Any]]: