peterbrittain/asciimatics

Developer documentation

Open

#38 opened on Aug 12, 2016

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Python (3,479 stars) (244 forks)batch import
Documentationhelp wanted

Description

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.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Python knowledgeUnderstanding of asciimatics internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Explore the asciimatics codebase, focusing on the Windows/Curses screens implementation, the Effects and Scenes API, and the frame skipping logic. Review any existing documentation in the repository. Write a developer guide covering these topics, referencing source files like screens.py, effects.py, and scenes.py.