Skip to content

Commit 85aaf79

Browse files
MImmesbergerclaude
andcommitted
GEP 10: cut redundant restatements of the flow-token period rule
The "a …_FLOW token needs a period; everything else is complete" rule was stated verbatim in the vocabulary section although "The available units" already gives it in full a few paragraphs earlier; drop it there and keep only the unique "tokens are not pint syntax" point. Thin the Backward-Compatibility mention of reference_period to a pointer at the canonical Flow-tokens section instead of re-listing dicts/schedules/lookup tables. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 2dc80ba commit 85aaf79

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

docs/geps/gep-10.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,9 @@ outputs.
143143
- **User code shape is unchanged.** Bare arrays and the DataFrame/mapper interface keep
144144
working; `currency` defaults to `"EUR"` and output stays in Euros.
145145
- **The `unit`/`reference_period` metadata is repurposed.** `unit` becomes one member of
146-
the token vocabulary and `reference_period` becomes *functional* (it supplies the
147-
period for structured `…_FLOW` parameters — dicts, schedules, lookup tables — which do
148-
not auto-convert) rather than purely descriptive.
146+
the token vocabulary and `reference_period` becomes *functional* — it now supplies the
147+
period for the structured flow parameters that cannot read a name suffix
148+
({ref}`Flow tokens <gep-10-periods>`) rather than being purely descriptive.
149149
- **No blanket opt-out.** Unlike the {ref}`GEP 9 <gep-9>` beartype claw, there is no
150150
env-var escape hatch that switches the unit check off wholesale. Users can opt-out of
151151
unit checking for specific functions (`verify_units=False`,
@@ -173,10 +173,8 @@ enumeration — a `Unit` `StrEnum` shipped by `ttsim`, spelled identically in co
173173
| `SQUARE_METERS` | `meter ** 2` | dwelling size |
174174
| `CURRENCY_PER_SQUARE_METER_FLOW` | `CURRENCY / meter ** 2 / period` | rent caps |
175175

176-
A token ending in `…_FLOW` needs a period; every other token is complete as written and
177-
takes no period. Tokens are not pint syntax: each resolves internally to a pint unit
178-
(flow tokens after the period is filled in), but pint expressions never appear in a
179-
declaration.
176+
Tokens are not pint syntax: each resolves internally to a pint unit (flow tokens after
177+
the period is filled in), but pint expressions never appear in a declaration.
180178

181179
`HOURS_FLOW` is the one flow token that resolves to a *dimensionless* quantity: hours
182180
and the period are both `[time]`, so hours per week is a time-over-time ratio. It is

0 commit comments

Comments
 (0)