openapi: Use "description: |" for multiline paragraphs.

"description: |" supports markdown and is overall better for
writing multiline paragraphs. So use it in multiline paragraphs
and line-wrap the newly formed paragraphs accordingly.

Edited by tabbott to change most single-line descriptions to use this
format as well.
This commit is contained in:
orientor
2020-04-16 16:50:32 +05:30
committed by Tim Abbott
parent a2781e6364
commit cfa7724bcc
2 changed files with 662 additions and 471 deletions

View File

@@ -57,7 +57,7 @@ class OpenAPIToolsTest(ZulipTestCase):
'name': 'message_id',
'in': 'path',
'description':
'The ID of the message that you wish to edit/update.',
'The ID of the message that you wish to edit/update.\n',
'example': 42,
'required': True,
'schema': {'type': 'integer'}