Foreman

Case study · Write docs

Document config.py environment variables in README.md

document in README.md every environment variable config.py reads, with its default

Write docs

fm code 'document in README.md every environment variable config.py reads, with its default' --worker claude

fm code tui at the end of this run: Document config.py environment variables in README.md

Plan FEATURE S · Document config.py environment variables in README.md

Steps

  1. Add an 'Environment variables' section to README.md with a table of variable, default and meaning for APP_PORT (8080), APP_DEBUG (off; debug is on only when set to 1) and APP_DB (sqlite:///app.db)
  2. Run the three verify greps to confirm each variable is documented

Checks

  • PASS README.md lists APP_PORT with its default 8080grep -q 'APP_PORT' README.md && grep -q '8080' README.md (failed before the work)
  • PASS README.md lists APP_DEBUG with its default (unset, so debug is off unless the value is 1)grep -q 'APP_DEBUG' README.md (failed before the work)
  • PASS README.md lists APP_DB with its default sqlite:///app.dbgrep -q 'APP_DB' README.md && grep -q 'sqlite:///app.db' README.md (failed before the work)

Changed

  • README.md +8

Closed T-0001 closed; committed 085d709 (1 file). Undo: git revert --no-edit 085d709 (tokens: 66198 in, 550 out)

2 worker turns · 67k tokens · 42s · replay it: fm code tui --events demo/examples/docs.jsonl · the case study

The run, event by event

  1. 12s before fails: grep -q 'APP_PORT' README.md && grep -q '8080' README.md
  2. 12s before fails: grep -q 'APP_DEBUG' README.md
  3. 12s before fails: grep -q 'APP_DB' README.md && grep -q 'sqlite:///app.db' README.md
  4. 12s step step 1/2: Add an 'Environment variables' section to README.md with a table of variable, default and meaning for APP_PORT (8080), APP_DEBUG (off; debug is on only when set to 1) and APP_DB (sqlite:///app.db)
  5. 25s changed README.md
  6. 25s step step 2/2: Run the three verify greps to confirm each variable is documented
  7. 40s changed README.md
  8. 40s check passes: grep -q 'APP_PORT' README.md && grep -q '8080' README.md
  9. 40s check passes: grep -q 'APP_DEBUG' README.md
  10. 41s check passes: grep -q 'APP_DB' README.md && grep -q 'sqlite:///app.db' README.md
  11. 42s closed T-0001 closed; committed 085d709 (1 file). Undo: git revert --no-edit 085d709 (tokens: 66198 in, 550 out)

Back to fm code