Conversation
Dary5
force-pushed
the
38-create-documentation
branch
from
a55e6b3 to
541b89d
Compare
| <details> | ||
| <summary> | ||
| <code> Calendar.py </code> | ||
| </summary> | ||
|
|
||
| <br> Это сущность не будет использована в MVP. |
There was a problem hiding this comment.
это я говорила выпилить
| <details> | ||
| <summary> | ||
| <code> User.py </code> | ||
| </summary> | ||
|
|
||
| | имя | тип | описание | | ||
| |:---:|:---:|:-------------------------------------:| | ||
| | id |int| уникальный идентификатор пользователя | |
| ├── Services | ||
| ├── LocalTaskService | ||
| ├── CalDavService | ||
| ├── ServerService |
There was a problem hiding this comment.
неверные названия серверов
There was a problem hiding this comment.
тут только LocalTaskService -> TaskService
There was a problem hiding this comment.
я знаю, если исправила - отлично
|
|
||
| ``` | ||
|
|
||
| ### Описание TaskService |
| TaskService - скрывает в себе работу с локальной базой данных, а также валидацией данных. | ||
| <details> | ||
| <summary> |
There was a problem hiding this comment.
этот кусок выглядит некрасиво, вставляй тэг: <br> для перехода на следующую строку
| CalDavService - скрывает в себе работу с удаленным сервером по протоколу CalDAV. | ||
| <details> | ||
| <summary> | ||
| <code> Метод get_all_tasks </code> |
There was a problem hiding this comment.
и вдруг родилось слово "Метод" в тэгах code...
| | Выходные параметры | Тип | | ||
| |:-------------------------------------------------:|:----:| | ||
| | Task entity - <br/> self.__task_from_event(event) | Task | |
There was a problem hiding this comment.
если я, как программист, который хочет воспользоваться этой документацией, открою и увижу этот тип - у меня глаза вылезут из орбит от удивления, что здесь происходит и какой наркоман это писал
There was a problem hiding this comment.
поправлю на просто Task без названия возвращаемого параметра
| <code> ServerService.py </code> | ||
| </summary> | ||
|
|
||
| ServerService - скрывает в себе работу с серверами, на которых хранятся задачи. |
There was a problem hiding this comment.
этот сервис, который работает с серверами в БД, а не с каким-то серверами, которые хранят задачи
| <summary> | ||
| <code> get_count </code> | ||
| </summary> | ||
| <br> Метод возвращает количество заданных email в репозитории. |
There was a problem hiding this comment.
Лучше звучит:
Возвращает число записей, соответствующих переданному email
| </summary> | ||
| <br> Метод возвращает список статусов по id сервера, на котором они хранятся. | ||
| Если был передан не id, то возникает ошибка Invalid("Невозможно открыть список статусов"). |
There was a problem hiding this comment.
Возвращает список статусов, которые соответствуют определенному серверу
Dary5
force-pushed
the
38-create-documentation
branch
from
8e35736 to
6ea37fd
Compare
Dary5
force-pushed
the
38-create-documentation
branch
from
23268a8 to
3da4a14
Compare
|
|
||
| | имя | тип | описание | | ||
| |:---------------:|:---:|:--------:| | ||
| | id |int|уникальный идентификатор задачи| | ||
| | number |int|номер задачи на текущем уровне| | ||
| | path |text|путь до этой задачи| | ||
| | dtstamp |date| дата создания задачи| | ||
| | dtstart |date| дата начала задачи| | ||
| | due |date| дата окончания задачи| | ||
| | category |list| категория задачи| | ||
| | summary |text| наименование задачи| | ||
| | status |int| статус задачи (выполнена/не выполнена)| | ||
| |technical_status |int| технический статус задачи (создана, удалена, изменена...)| | ||
| | description |text| описание задачи| |
There was a problem hiding this comment.
сущность нужно обновить, у нее старые поля
Dary5
force-pushed
the
38-create-documentation
branch
3 times, most recently
from
32e1a7f to
9527846
Compare
|
@astronik00 добавила описание объекта Session и описала основные методы, проверь пожалуйста |
Dary5
force-pushed
the
38-create-documentation
branch
2 times, most recently
from
6f73964 to
2e922e6
Compare
Dary5
force-pushed
the
38-create-documentation
branch
from
457337e to
71a9bcf
Compare
Dary5
force-pushed
the
38-create-documentation
branch
from
71a9bcf to
f23be7d
Compare
2 participants
Task merge request
#38
Особых требований нет
Code changes
Описание классов, сервисов и репозиториев.