Docstring coverage report — public surface¶
Auto-generated by scripts/audit_docstrings.py. Read alongside the gate's curated exemption list at docstring_gaps.toml.
Tier model from CONTRACT v1.0 #C2: 100% on the explicit public surface (symbols in __all__), 80% on the second ring (importable but not re-exported), no gate on internals.
Classification: full (≥3 lines OR has Args/Returns/Raises/Examples), one-line (single line; renders but thin), missing (no docstring).
Ring 0 — activegraph (public surface, target 100%)¶
- [x]
ActiveGraphError - [x]
AmbiguousBehaviorError - [ ]
AmbiguousToolError— one-line - [x]
ApprovalNotFoundError - [ ]
Behavior— one-line - [x]
BehaviorNotFoundError - [ ]
Budget— missing - [ ]
Clock— one-line - [ ]
ConfigurationError— one-line - [x]
CorruptedEventPayloadError - [ ]
Diff— one-line - [ ]
DiscoveredPack— one-line - [ ]
DivergentObject— one-line - [ ]
DivergentRelation— one-line - [x]
DuplicateEventError - [ ]
EmptySettings— one-line - [ ]
Event— one-line - [x]
EventNotFoundError - [ ]
EventStore— one-line - [x]
ExecutionError - [ ]
Frame— one-line - [ ]
FrozenClock— one-line - [ ]
Graph— one-line - [ ]
IDGen— one-line - [ ]
InMemoryEventStore— missing - [x]
IncompatibleRuntimeState - [x]
InternalEvaluatorError - [x]
InvalidActivateAfter - [x]
InvalidArgumentType - [x]
InvalidPatchLifecycleState - [x]
InvalidRuntimeConfiguration - [x]
InvalidStoreURL - [x]
InvalidToolRegistration - [x]
LLMBehavior - [x]
LLMBehaviorError - [x]
Metrics - [ ]
MigrationReport— one-line - [ ]
MigrationRunReport— one-line - [x]
MissingOptionalDependency - [x]
MissingProviderError - [x]
MissingToolError - [x]
NoOpMetrics - [x]
NonSerializableEventError - [ ]
Object— one-line - [x]
ObjectType - [x]
Pack - [x]
PackConflictError - [x]
PackError - [x]
PackNotFoundError - [x]
PackPolicy - [x]
PackPrompt - [ ]
PackPromptLoadError— one-line - [x]
PackSchemaViolation - [ ]
PackSettingsMissingError— one-line - [x]
PackValidationError - [x]
PackVersionConflictError - [ ]
Patch— one-line - [ ]
PatternError— one-line - [x]
PendingApproval - [ ]
Policy— one-line - [x]
PrometheusMetrics - [x]
RegistrationError - [ ]
Relation— one-line - [ ]
RelationBehavior— one-line - [x]
RelationType - [x]
ReplayDivergenceError - [x]
ReplayError - [ ]
RunRecord— one-line - [ ]
Runtime— missing - [x]
RuntimeContextRequiredError - [ ]
RuntimeStatus— one-line - [ ]
SQLiteEventStore— one-line - [x]
SchemaVersionMismatch - [ ]
StorageError— one-line - [ ]
TickingClock— one-line - [ ]
Tool— one-line - [ ]
ToolContext— one-line - [x]
ToolError - [x]
ToolNotFoundError - [x]
UnknownToolError - [x]
UnsupportedPatternError - [ ]
View— missing - [x]
behavior - [ ]
clear_discovery_cache— one-line - [ ]
clear_registry— missing - [ ]
clear_tool_registry— missing - [x]
configure_logging - [x]
discover - [ ]
get_registry— missing - [ ]
get_tool_registry— missing - [x]
llm_behavior - [ ]
load_by_name— one-line - [x]
load_prompts_from_dir - [x]
migrate - [x]
open_store - [ ]
parse_store_url— one-line - [x]
relation_behavior - [x]
tool
Ring 0 — activegraph.packs.diligence (public surface, target 100%)¶
- [x]
DiligenceSettings - [x]
pack
Ring 1 — importable but not in __all__ (target 80% not-missing)¶
activegraph.cli.main¶
- [x]
main
activegraph.cli.quickstart¶
- [x]
run_fixture_mode - [x]
run_interactive_mode
activegraph.core.graph¶
- [x]
apply_event - [x]
evaluate_where
activegraph.errors¶
- [x]
internal_bug_fields
activegraph.llm.anthropic¶
- [x]
AnthropicProvider
activegraph.llm.cache¶
- [x]
CachedEntry— one-line - [ ]
LLMCache— missing
activegraph.llm.prompt¶
- [x]
AssembledPrompt - [x]
assemble_prompt - [x]
build_instruction - [x]
build_system_prompt - [ ]
build_user_message— missing - [x]
schema_to_json - [x]
serialize_view
activegraph.llm.provider¶
- [x]
LLMProvider
activegraph.llm.recorded¶
- [x]
RecordedLLMProvider - [x]
RecordingLLMProvider
activegraph.llm.types¶
- [x]
LLMMessage - [x]
LLMResponse— one-line - [x]
ToolCall
activegraph.observability.logging¶
- [x]
JsonLineFormatter - [x]
get_logger - [x]
redact_payload— one-line - [x]
runtime_log_extra - [x]
set_payload_redactor— one-line
activegraph.observability.metrics¶
- [x]
MetricSpec— one-line - [x]
validate_cardinality_rule
activegraph.observability.status¶
- [x]
BehaviorInfo— one-line - [x]
BudgetSnapshot— one-line - [x]
EventSummary— one-line - [x]
FrameSnapshot— one-line - [x]
status_to_dict
activegraph.packs¶
- [x]
behavior— one-line - [x]
llm_behavior— one-line - [x]
relation_behavior— one-line - [x]
tool
activegraph.packs.diligence.behaviors¶
- [x]
MemoBody - [x]
QuestionList - [x]
ResearchFindings - [x]
ResearcherClaim - [x]
RiskList
activegraph.packs.diligence.fixtures¶
- [x]
RecordedDiligenceProvider - [ ]
lookup_company_docs— missing - [ ]
lookup_filings— missing - [ ]
lookup_summary— missing
activegraph.packs.diligence.fixtures.companies¶
- [ ]
company_goal— missing
activegraph.packs.diligence.object_types¶
- [x]
Claim— one-line - [x]
Company— one-line - [x]
Contradiction - [x]
Document— one-line - [x]
Evidence— one-line - [x]
Memo - [x]
Question— one-line - [x]
Risk— one-line
activegraph.packs.diligence.tools¶
- [x]
DocumentRef - [x]
FetchCompanyDocsInput - [x]
FetchCompanyDocsOutput - [x]
SearchFilingsInput - [x]
SearchFilingsOutput - [x]
SummarizeDocumentInput - [x]
SummarizeDocumentOutput
activegraph.packs.loader¶
- [x]
PackRuntimeState— one-line - [x]
load_pack_into_runtime— one-line
activegraph.packs.scaffold¶
- [x]
normalize_pack_name - [x]
scaffold_pack
activegraph.runtime.behavior_graph¶
- [ ]
BehaviorGraph— missing - [ ]
Counters— missing
activegraph.runtime.diff¶
- [ ]
compute_diff— missing
activegraph.runtime.patterns¶
- [x]
AndExpr— one-line - [x]
Comparison— one-line - [x]
Match - [x]
MatchClause - [x]
NodePat— one-line - [x]
NotExists— one-line - [x]
NotExpr— one-line - [x]
Pattern— one-line - [x]
PatternMatcher— one-line - [x]
RelPat— one-line - [x]
Tok— one-line - [x]
parse— one-line
activegraph.runtime.queue¶
- [ ]
EventQueue— missing
activegraph.runtime.registry¶
- [ ]
Registry— missing
activegraph.runtime.runtime¶
- [x]
Context— one-line
activegraph.runtime.scheduler¶
- [x]
DelayedQueue— one-line - [x]
ScheduledEntry— one-line - [x]
parse_activate_after
activegraph.runtime.view_builder¶
- [ ]
build_view— missing
activegraph.store.base¶
- [x]
replay_into
activegraph.store.conformance¶
- [x]
EventStoreConformance
activegraph.store.postgres¶
- [x]
PostgresEventStore— one-line
activegraph.store.serde¶
- [x]
decode_event— one-line - [x]
decode_payload - [x]
encode_event— one-line - [x]
encode_payload— one-line - [x]
validate_event— one-line
activegraph.store.url¶
- [x]
StoreURL— one-line
activegraph.tools.cache¶
- [x]
CachedToolResponse— one-line - [ ]
ToolCache— missing - [x]
canonicalize_args - [ ]
hash_tool_call— missing
activegraph.tools.graph_query¶
- [x]
GraphQueryInput - [x]
GraphQueryOutput - [x]
ObjectRef - [x]
make_graph_query_tool
activegraph.tools.recorded¶
- [x]
DirectToolInvoker - [x]
RecordedToolProvider— one-line - [x]
RecordingToolProvider
activegraph.tools.web_fetch¶
- [x]
WebFetchInput - [x]
WebFetchOutput
activegraph.trace.causal¶
- [ ]
causal_chain— missing
activegraph.trace.printer¶
- [ ]
Trace— missing - [ ]
format_event— missing
Summary¶
Ring 0 — public surface (target 100%)¶
- 57/100 fully documented (57.0%) — gap to 100% full: 43 symbols
- 92/100 not-missing (92.0%) — gap to 100% not-missing: 8 symbols (these need
docstring_gaps.tomlexemptions for the gate to pass)
Ring 0 missing-entirely (gate exemptions):
activegraph.Budgetactivegraph.InMemoryEventStoreactivegraph.Runtimeactivegraph.Viewactivegraph.clear_registryactivegraph.clear_tool_registryactivegraph.get_registryactivegraph.get_tool_registry
Ring 1 — importable but not in __all__ (target 80% not-missing)¶
- 56/114 fully documented (49.1%) — v1.1 burndown target is 100% full
- 97/114 not-missing (85.1%) — gate threshold is 80% not-missing
Ring 1 is above the 80% gate threshold. The gate enforces the threshold; individual missing-Ring-1 symbols are v1.1 burndown items, not gate exemptions.