Как писать развернутые объяснения в описаниях?
Если для описания модели вам нужно больше одного предложения, вы можете:
- Разбить описание на несколько строк с помощью
>. Переносы строк внутри описания удаляются, при этом можно использовать Markdown. Этот способ рекомендуется для простых описаний из одного абзаца:
models:
- name: customers
description: >
Lorem ipsum **dolor** sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat.
- Разбейте описание на несколько строк с помощью
|. Внутренние переносы строк сохраняются, и можно использовать Markdown. Этот способ рекомендуется для более сложных описаний:
models:
- name: customers
description: |
### Lorem ipsum
* dolor sit amet, consectetur adipisicing elit, sed do eiusmod
* tempor incididunt ut labore et dolore magna aliqua.
- Использовать блок docs, чтобы написать описание в отдельном Markdown файле.
Нашли ошибку?
0