Cleaned up documentation and removed stubs and TODOs throughout the application
This commit is contained in:
@@ -1,10 +1,12 @@
|
||||
// Package sources defines feedkit's input-source abstraction.
|
||||
// Package sources defines feedkit's input-source abstractions and source
|
||||
// registry.
|
||||
//
|
||||
// A source ingests upstream input and emits one or more event.Event values.
|
||||
//
|
||||
// feedkit supports two source modes:
|
||||
// - PollSource: scheduler invokes Poll on a cadence.
|
||||
// - StreamSource: source runs continuously and pushes events as input arrives.
|
||||
// External API surface:
|
||||
// - Input: common source identity surface
|
||||
// - PollSource: polling source interface
|
||||
// - StreamSource: streaming source interface
|
||||
// - Registry / NewRegistry: source driver registry and builders
|
||||
// - HTTPSource / NewHTTPSource: reusable HTTP polling helper
|
||||
//
|
||||
// Source drivers are domain-specific and registered into Registry by driver name.
|
||||
// Registry can then build configured sources from config.SourceConfig.
|
||||
@@ -12,6 +14,12 @@
|
||||
// A single source may emit 0..N events per poll or stream iteration, and those
|
||||
// events may span multiple event kinds.
|
||||
//
|
||||
// Optional helpers from helpers.go:
|
||||
// - DefaultEventID: default event ID policy for source implementations
|
||||
// - SingleEvent: construct and validate a one-element event slice
|
||||
// - ValidateExpectedKinds: compare configured expected kinds against source
|
||||
// advertised kinds when metadata is available
|
||||
//
|
||||
// HTTP-backed polling sources can share NewHTTPSource for generic HTTP config
|
||||
// parsing and conditional GET behavior. The helper understands:
|
||||
// - params.url
|
||||
|
||||
Reference in New Issue
Block a user