Skip to content

Coding Style

mzuelch edited this page Jan 24, 2026 · 1 revision

Guidelines to keep the codebase consistent.

General

  • Prefer small, testable functions.
  • Keep UI logic (widget state) separate from backend orchestration.
  • Avoid heavy imports at module import time (especially for plugins).

Types & errors

  • Use type hints on public functions/classes.
  • Raise clear exceptions in the backend; surface them in the UI with traceback.

Audio processing

  • Document sample rate assumptions.
  • Keep DSP functions pure (no hidden global state).
  • Ensure multi-channel behavior is explicit.

Last updated: 2026-01-24

Clone this wiki locally