-
Notifications
You must be signed in to change notification settings - Fork 0
Документировать параметры фасадов #1
Copy link
Copy link
Open
Labels
backendIt's a serviceIt's a servicedocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomersvery smallMaximum 2 hoursMaximum 2 hours
Description
Activity
Metadata
Metadata
Assignees
Labels
backendIt's a serviceIt's a servicedocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomersvery smallMaximum 2 hoursMaximum 2 hours
Мотивация
Непонятны варианты параметров функций API фасадов из-за чего приходится лезть в кишки модулей, что по идее должно предотвращаться из-за самого существование API фасадов и их функций.
Решение
Нужно в функциях API фасадов (содержимое
presentation.periphery.facade) документировать их параметры при помощиDoc.Информация, выраженная в описаниях
Doc, должна оповещать о вариантах входного значения для валидного и невалидного выполнения функции.Порты - клиенты, которые обращаются к фасадам для доступа к другим модулям документировать не нужно.
Заблокировано по #35.