peterbrittain/asciimatics

Developer documentation

Open

#38 aperta il 12 ago 2016

Vedi su GitHub
 (2 commenti) (1 reazione) (0 assegnatari)Python (244 fork)batch import
Documentationhelp wanted

Metriche repository

Star
 (3479 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

There are some aspects of the design that should be documented in a little more detail, but they don't naturally fall in the user guide. For example:

  1. Internals of Windows/Curses Screens
  2. Formal internal API for Effects and Scenes.
  3. Frame skipping for refresh (in order to reduce CPU)

This should be fleshed out into a proper developer guide.

Guida contributor

Direzione di ricerca
Esamina il codice sorgente di asciimatics per la gestione dello schermo Windows/Curses, l'API di Effects e Scenes e la logica di frame skipping. Documenta gli aspetti interni in una guida per sviluppatori.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65