Skip to content

workbench.md

Latest commit

 

History

History
32 lines (25 loc) · 1.06 KB

workbench.md

File metadata and controls

32 lines (25 loc) · 1.06 KB
Raw
name workbench-overview
doc_type verification
description High-level walkthrough of the manual workbench area. Use when you need the workbench validation story.

Workbench Overview

Overview

workbench/ is for manual probes that investigate behavior outside shipped package code and outside default pytest. Use examples/ for canonical runnable public API demos; use workbench/ for questions that are still exploratory. The baseline keeps the folder empty except for package markers.

Question this diagram answers: What validation role does workbench play?

flowchart TD
    A["Workbench"] --> B["Isolated behavior probe"]
    B --> C["Manual evidence"]
    C --> D["Decision for src or tests"]
Loading

Rules

  • Add a workbench module only for a real investigation or live dependency question.
  • Keep workbench scripts direct-runnable with python -m ....
  • Move stable caller-facing demonstrations to examples/.
  • Do not import workbench code from shipped package code.
  • Do not treat manual workbench evidence as a replacement for committed tests.