Skip to content

Example authoring

Rules for examples/docs/*.py:

  • expose run_example()
  • keep the example focused on one primary decision
  • prefer deterministic local behavior
  • document prerequisites and artifacts in the docs page that embeds the example
  • avoid relying on undocumented internal implementation details
  • use tiny fixture data
  • make provider-backed examples runnable with fake or injected clients when possible