SUAI-TaskPlanner-Contest / TaskPlanner

Client application for working with todos and syncing with CalDAV servers
MIT License
3 stars 2 forks source link

2 create template project #35

Closed slavakyrlan closed 1 year ago

slavakyrlan commented 1 year ago

Task merge request

Related Issue _#24_
Reviewer requrements Нет

Code changes

  1. Создан файл main.py содержит основной код приложения.
  2. Создан файл requirements.txt содержит необходимые библиотеки для работы приложения.
  3. Созданы файлы .md с описанием каждого файла.
  4. Созданы файлы .qml содержат настройки всех окон.

UI Demonstration

111111

How to test

  1. Проверить читаемость и понимание описания каждого объекта.
  2. Проверить работоспособность приложения.

Инструкция:

  1. Устанавливаем библиотеки:
    pip install -r requirements.txt
  2. Запускаем файл в cmd:
    python main.py
astronik00 commented 1 year ago

@slavakyrlan, @ISAchainSAW Определитесь с код стайлом - у вас одновременно существуют модули "main.py", "main.qml" и "AnotherWindow.py".

astronik00 commented 1 year ago

@slavakyrlan, @ISAchainSAW

Вы создаете структуру нашего будущего проекта, а не структуру урока с этого сайта. Папка QML подразумевается, как папка, хранящая загружающиеся окна. Почему у вас существует непонятно к чему привязанное окно AnotherWindow?

У нас есть определенный список окон: главное окно, окно авторизации, окно выбора сервера, окно настроек, почему нельзя было использовать эти названия? Создайте понятные окна: MainWindow, AuthWindow, SettingsWindow и так далее. Сделайте переключение между ними в соответствие с тем, что рассказывала Даша в четверг.

astronik00 commented 1 year ago

@slavakyrlan, @ISAchainSAW

Просмотрела документацию. Я просила описать свои созданные классы, не нужно в таких подробностях описывать системные классы. Вы пишите документацию для собственно реализованных функций и классов, а не копию документации QML. Переделайте дерево из цитат, а то это какой-то ужас. В комментариях к вашей же задаче я оставляла более читаемый шаблон дерева, где можно увидеть, что оформляется это следующим образом:

├── a ├── a.a ├── a.b ... ...

К тому же, в новой редакции не думаю, что это дерево вообще нужно будет.

Также почему если следующий код:

anotherWindow.signalExit()

используется в файле main.qml, вы его описываете не в Main.md?

Вы создали уже папку Description, зачем приписывать это к каждому файлу? И так понятно, что это документация вместе с расширением .md.

slavakyrlan commented 1 year ago

Task merge request

Related Issue _#24_
Reviewer requrements Нет

Code changes

  1. Создан файл main.py содержит основной код приложения.
  2. Создан файл requirements.txt содержит необходимые библиотеки для работы приложения.
  3. Созданы файлы .md с описанием каждого файла.
  4. Созданы файлы .qml содержат настройки всех окон.

UI Demonstration

111111

How to test

  1. Проверить читаемость и понимание описания каждого объекта.
  2. Проверить работоспособность приложения.

Инструкция:

  1. Устанавливаем библиотеки:
    pip install -r requirements.txt
  2. Запускаем файл в cmd:
    python main.py