Updated documentation for internal consistency.

This commit is contained in:
2026-01-15 10:47:59 -06:00
parent 84c4efbc2e
commit 1790218d38
2 changed files with 13 additions and 7 deletions

View File

@@ -68,7 +68,7 @@
// //
// weather.<kind>.vN // weather.<kind>.vN
// //
// weatherfeeder centralizes schema strings in internal/standards/schemas.go. // weatherfeeder centralizes schema strings in internal/standards/schema.go.
// Always use those constants (do not inline schema strings). // Always use those constants (do not inline schema strings).
// //
// Example mappings: // Example mappings:

View File

@@ -1,8 +1,14 @@
// Package standards contains shared canonical vocabularies and lookup tables // File: internal/standards/doc.go
// used across multiple providers.
// //
// The guiding principle is: // Package standards defines weatherfeeders provider-agnostic “project law”:
// - Canonical types live in internal/model (provider-independent). //
// - Shared reference tables and helpers live here. // - Schema identifiers and versioning conventions (see schema.go).
// - Provider-specific mapping logic lives in internal/sources/<provider>. // - Canonical interpretations / cross-provider mappings that are not specific to a
// single upstream API (e.g., shared code tables, text heuristics, unit policy).
//
// Standards are used by both sources and normalizers. Keep this package free of
// provider-specific logic and free of dependencies on internal/sources/* or
// internal/normalizers/* to avoid import cycles.
//
// Provider-specific decoding and mapping lives in internal/normalizers/<provider>.
package standards package standards