Align documentation with cleanup results
This commit is contained in:
@@ -6,7 +6,8 @@ This guide describes the implemented Markdown report template surface for
|
||||
`weatherreporter`. It is for maintainers editing embedded report templates,
|
||||
especially generated-text-template reports.
|
||||
|
||||
Templates are Go `text/template` files. The current implemented templates are:
|
||||
Templates are Go `text/template` files. The implemented top-level templates
|
||||
are:
|
||||
|
||||
- `internal/reporttemplate/templates/daily.md.tmpl`
|
||||
- `internal/reporttemplate/templates/today.md.tmpl`
|
||||
@@ -32,7 +33,7 @@ validation, and artifact paths are handled before template rendering.
|
||||
- Do not put weather derivation, source selection, or path construction logic in
|
||||
templates.
|
||||
- Missing template keys are errors. A misspelled variable will fail rendering.
|
||||
- No custom template functions are currently registered.
|
||||
- No custom template functions are registered.
|
||||
- Named partials are invoked with `{{ template "name" . }}`. Pass the current
|
||||
render context (`.`) unless the partial is intentionally designed for a
|
||||
narrower value.
|
||||
@@ -112,6 +113,9 @@ Tomorrow generated text uses the same `.GeneratedText.Summary`,
|
||||
Hourly. `.GeneratedText.ForecastDiscussion` is a slice of paragraphs and should
|
||||
be rendered with `range`.
|
||||
|
||||
Tomorrow uses the shared `daypart_forecast` and `precipitation_timing`
|
||||
partials.
|
||||
|
||||
Tomorrow modules include the Hourly module fields plus:
|
||||
|
||||
| Variable | Type | Description |
|
||||
|
||||
Reference in New Issue
Block a user