From 1790218d38dc11273a9c4f1b4b745ca81b7bc234 Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Thu, 15 Jan 2026 10:47:59 -0600 Subject: [PATCH] Updated documentation for internal consistency. --- internal/normalizers/doc.go | 2 +- internal/standards/doc.go | 18 ++++++++++++------ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/internal/normalizers/doc.go b/internal/normalizers/doc.go index a8bb850..0548d6d 100644 --- a/internal/normalizers/doc.go +++ b/internal/normalizers/doc.go @@ -68,7 +68,7 @@ // // weather..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). // // Example mappings: diff --git a/internal/standards/doc.go b/internal/standards/doc.go index e3c6a8c..c323f61 100644 --- a/internal/standards/doc.go +++ b/internal/standards/doc.go @@ -1,8 +1,14 @@ -// Package standards contains shared canonical vocabularies and lookup tables -// used across multiple providers. +// File: internal/standards/doc.go // -// The guiding principle is: -// - Canonical types live in internal/model (provider-independent). -// - Shared reference tables and helpers live here. -// - Provider-specific mapping logic lives in internal/sources/. +// Package standards defines weatherfeeder’s provider-agnostic “project law”: +// +// - Schema identifiers and versioning conventions (see schema.go). +// - 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/. package standards