Konsistenten stil obstoječih nalog

[MightyOwler]

• uporabi smiselna imena spremenljivk v generatorjih
• konsistentno napiši help_text v parametrih
• uporabljaj validate namesto GeneratedDataIncorrect
• uporabljene konvencije zapiši v CONTRIBUTING.md

Trenutno se v razredih, ki definirajo posamezne probleme, nahaja ogromno spremenljivk, katerih pomen ni takoj jasen. Pri tem so še najbolj moteča enočrkovna imena.

Predlagam, da se ta imena pregleda in smiselno popravi.

[matijapretnar]

Se strinjam. V resnici tale issue izkoriščam za ene stvari, ki so me že prej motile. Na vrhu sem dodal še dva todoja in sicer:

• help_text, ki se pojavi spodaj, je verjetno nekonsistenten. Npr. nekje pod stevilo_nicel bi lahko pisalo Parameter, ki določi število ničel zgeneriranega polinoma, nekje drugje pa Število ničel polinoma. Verjetno je krajši način boljši, ker je kontekst jasen, ampak kar koli že, mora nekdo pogledati, ali so stvari konsistentne.
• kar koli se bomo že odločili glede spremenljivk, opisa parametrov, … je dobro zapisati, da bomo vedeli, kakšne morajo biti bodoče naloge.

Če je še kakšna taka stvar, jo bomo dodali v ta TODO.

[jangnamus]

zanimivi predlogi