První pokus odevzdání projektu

[l-nagy-utb-fai]

První pokus odevzdání projektu

[turecekt]

• soubor test.py přejmenovat na test_functions.py aby jej pytest naimportoval
• soubor Návrh programu přejmenovat na README.md
• odstranit soubor example.py
• odstranit všechny soubory .html
• dopsat docstringy do všech modulů a funkcí aby prošlo přes flake8
• v sekci About na hlavní stránce repa následně upravit Website url na url vašich gh-pages s automaticky vygenerovanou dokumentací.

[turecekt]

stejně opravit i functions.py

[turecekt]

• syntaxe opravena a pytest prochází bez chyby, teď ještě vyčistit kód aby prošel přes flake8 viz sekce Actions - build ve vašem repozitáři:
  flake8 .
  ./functions.py:1:1: D300 Use """triple double quotes"""
  ./functions.py:1:1: D400 First line should end with a period
  ./functions.py:15:1: D300 Use """triple double quotes"""
  ./functions.py:15:1: D400 First line should end with a period
  ./functions.py:35:1: D300 Use """triple double quotes"""
  ./functions.py:35:1: D400 First line should end with a period
  ./test_functions.py:1:1: D300 Use """triple double quotes"""
  ./test_functions.py:1:1: D400 First line should end with a period
  ./test_functions.py:4:1: E402 module level import not at top of file
  ./test_functions.py:9:1: D204 1 blank line required after class docstring
  ./test_functions.py:9:1: D300 Use """triple double quotes"""
  ./test_functions.py:9:1: D400 First line should end with a period
  ./test_functions.py:11:1: D300 Use """triple double quotes"""
  ./test_functions.py:11:1: D400 First line should end with a period
  ./test_functions.py:17:1: D300 Use """triple double quotes"""
  ./test_functions.py:17:1: D400 First line should end with a period
  ./test_functions.py:23:1: D300 Use """triple double quotes"""
  ./test_functions.py:23:1: D400 First line should end with a period
  ./test_functions.py:28:1: D300 Use """triple double quotes"""
  ./test_functions.py:28:1: D400 First line should end with a period
  ./test_functions.py:38:1: D204 1 blank line required after class docstring
  ./test_functions.py:38:1: D300 Use """triple double quotes"""
  ./test_functions.py:38:1: D400 First line should end with a period
  ./test_functions.py:40:1: D300 Use """triple double quotes"""
  ./test_functions.py:40:1: D400 First line should end with a period
  ./test_functions.py:46:1: D300 Use """triple double quotes"""
  ./test_functions.py:46:1: D400 First line should end with a period
  ./test_functions.py:52:1: D300 Use """triple double quotes"""
  ./test_functions.py:52:1: D400 First line should end with a period
  ./test_functions.py:58:1: D300 Use """triple double quotes"""
  ./test_functions.py:58:1: D400 First line should end with a period

[turecekt]

v sekci About na hlavní stránce repa upravit Website url na url vašich gh-pages s automaticky vygenerovanou dokumentací.

[l-nagy-utb-fai]

v sekci About na hlavní stránce repa upravit Website url na url vašich gh-pages s automaticky vygenerovanou dokumentací.

Je potřeba ještě něco udělat?

[turecekt]

tento popisek trochu rozepsat

[turecekt]

A u obou funkcí ve functions.py dopnit ještě datové typy parametrů funkce a návratových hodnot v definici funkce(type hints) a jejich popis v rozšířeném docstringu formou reST(:param: a :return:) viz zde: https://github.com/turecekt/vs_project/blob/master/example.py

[turecekt]

Akorád ještě napřed v Actions zrušit workflow "pages-build-deployment" a v nastavení repozitáře v settings v sekci Pages je nutné nastavit Build and Deployment Source na Github Actions a následně ještě zařadit navrhovanou změnu (měla by se tak po commitu automaticky přegenerovat a vystavit dokumentace).

[turecekt]

• odstranit z repozitáře soubor jekyll-gh-pages.yml