Skip to content

Commit 0cdcac0

Browse files
committed
Use a multiline description in docstring - broken...
1 parent 45a3784 commit 0cdcac0

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

examples/document.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ A model for documents
3838
</table>
3939

4040
## Section
41-
A model of a section of the <a href="#document">Document</a>. Will contain one <a href="#paragraph">Paragraph</a> or more
41+
Will contain one <a href="#paragraph">Paragraph</a> or more.
4242

4343
### Allowed parameters
4444
<table>

examples/document.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ class Paragraph(Base):
2121
@modelspec.define
2222
class Section(Base):
2323
"""
24-
A model of a section of the :class:`Document`. Will contain one :class:`Paragraph` or more
24+
A model of a section of the :class:`Document`.
25+
Will contain one :class:`Paragraph` or more.
2526
2627
Args:
2728
id: The id of the section

examples/document.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Allowed child Data Type Description
2424
=======
2525
Section
2626
=======
27-
A model of a section of the <a href="#document">Document</a>. Will contain one <a href="#paragraph">Paragraph</a> or more
27+
Will contain one <a href="#paragraph">Paragraph</a> or more.
2828

2929
**Allowed parameters**
3030

examples/document.specification.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
}
2424
},
2525
"Section": {
26-
"definition": "A model of a section of the :class:`Document`. Will contain one :class:`Paragraph` or more",
26+
"definition": "Will contain one :class:`Paragraph` or more.",
2727
"allowed_parameters": {
2828
"id": {
2929
"type": "str",

examples/document.specification.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ Document:
1515
type: Section
1616
description: The sections of the document
1717
Section:
18-
definition: A model of a section of the :class:`Document`. Will contain one :class:`Paragraph`
19-
or more
18+
definition: Will contain one :class:`Paragraph` or more.
2019
allowed_parameters:
2120
id:
2221
type: str

0 commit comments

Comments
 (0)