[Plibonigo] Dokumenti la fontkodon.

[CourteousCoder]

Kialo

Tasko por dokumenti la deponejon, funkciojn, klasojn, ktp ofte estas bona una tasko por novaj kontribuantoj pro du ĉefaj kialoj:

1. Ĉar ĝi donos al ili oportunon ekkoni la fontkodon.
2. Ĉar ĝi helpos ĉiuj kontribuantoj havi pli da bona dokumentado en la projekto.

Tipoj de Dokumentado:

1. Projekt(er)-nivela per README.md dosieroj
2. Klas-nivela kaj funkci-nivela per Pitonaj DOCSTRING-aj komentoj.
3. Klarigo de koderoj, kiuj jam ne sufiĉe klaras.

Fina rimarko

Klari estas laŭ onia opinio, do oni eble devus skevi la stilon de la deponjeo.

[CourteousCoder]

Mi volontas fari ĉi-tiun taskon.