Skip to content

Comments

docs: Add container introspection and debugging guide#474

Merged
mikelane merged 2 commits intomainfrom
issue-351-introspection-docs
Feb 7, 2026
Merged

docs: Add container introspection and debugging guide#474
mikelane merged 2 commits intomainfrom
issue-351-introspection-docs

Conversation

@mikelane
Copy link
Owner

@mikelane mikelane commented Feb 7, 2026

Summary

  • Add docs/guides/debugging.md covering the three container introspection methods: debug(), explain(), and graph()
  • Add the guide to the Advanced Topics toctree in docs/index.md

What the guide covers

  • Quick reference table comparing debug() vs explain() vs graph()
  • debug(): registration summary, diagnosing "adapter not found" errors, checking lifecycle components, writing output to files
  • explain(cls): resolution tree visualization, port resolution, wrong adapter diagnosis, circular dependency detection, unregistered type handling
  • graph(): Mermaid and Graphviz DOT output formats, reading the graph, CI integration with a GitHub Actions example, embedding in documentation
  • Combined debugging workflow showing how to use all three methods together

Test plan

  • Sphinx build succeeds with no warnings related to the new file
  • New guide appears in the Advanced Topics toctree
  • Code examples match the actual API signatures in container.py
  • Output examples match the format produced by the implementation

Fixes #351

Generated with Claude Code

@codecov
Copy link

codecov bot commented Feb 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.85%. Comparing base (9f37e0b) to head (d376dc3).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #474   +/-   ##
=======================================
  Coverage   91.85%   91.85%           
=======================================
  Files          21       21           
  Lines        1903     1903           
  Branches      372      372           
=======================================
  Hits         1748     1748           
  Misses         91       91           
  Partials       64       64           
Flag Coverage Δ
python-3.13 91.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted file tree graph

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

The documented explain() tree output showed dependencies starting at
column 0, but the actual implementation indents them 4 spaces from the
parent. Fixed both the UserService and SelfRefService examples to match
real output.

Co-Authored-By: Claude <noreply@anthropic.com>
@mikelane mikelane merged commit b569e0d into main Feb 7, 2026
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Container Introspection: Documentation and Usage Guide

1 participant