google / google/codeworld

Improved documentation for builtin symbols

Aperta
#814 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
Haskell
Stelle
1.3k
Fork
201
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Now that we have more visible documentation in the editor, it's conspicuous how much the documentation is missing for a lot of builtin symbols. It would be good to add documentation (which just means haddock in the codeworld-base module) for all these definitions.

At the same time, I should rewrite the existing documentation to be clearer about function arguments. We should adopt this style for the first sentence of every function:

@thickArc(angle1, angle2, radius, thickness)@ is a @Picture@ of an arc
between the given angles, with the given radius and line thickness.

The documentation can go on to give examples and such, but that first sentence clarifies what each argument means in a precise way.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia nel modulo codeworld-base e rivedi le definizioni dei simboli builtin e i relativi commenti Haddock esistenti. Fai un inventario delle definizioni prive di documentazione, quindi rivedi la documentazione delle funzioni in modo che la prima frase di ciascuna spieghi gli argomenti nello stile richiesto. Il lavoro è completato quando le definizioni dei simboli builtin hanno la documentazione Haddock e le descrizioni esistenti definiscono chiaramente i relativi argomenti delle funzioni.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
haskell
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.