-
Notifications
You must be signed in to change notification settings - Fork 3
Docs: tighten numeric env-var parsing guarantee after #1991 lands #2036
Description
[product-owner]
As a self-hosting operator reading the configuration reference, I want the numeric-variable caution box to state the actual guarantee once strict parsing lands, so that I am not warned about a truncation hazard that no longer exists.
Priority: Could Have
Blocked by: #1991
Problem
docs/src/getting-started/configuration.md currently tells operators that an invalid numeric value causes startup failure, qualified — per PR #2027 — with the caveat that a value beginning with digits is truncated rather than rejected (AUTH_RATE_LIMIT_MAX=2e3 silently becomes 2).
That qualification is accurate today and was written deliberately as true-of-today, not as though #1991 had already landed. Once #1991 merges, loadConfig() rejects 2e3, 20abc, 20.9, and ' 20' outright, and the caveat becomes conservative but still true — it warns about a hazard that no longer exists.
Note the ordering is safe in one direction only: the docs never lie, they just understate. There is no window in which an operator is misinformed, which is why this is a follow-up rather than a co-requisite of #1991.
Acceptance Criteria
- 1 Given Tighten integer parsing for numeric environment variables in loadConfig() #1991 has merged, When the configuration reference describes numeric environment variables, Then the truncation caveat added by PR docs: document auth rate-limit env vars on configuration page #2027 is removed and the copy states the simpler guarantee: a malformed numeric value fails startup rather than being silently coerced.
- 2 The copy states what "malformed" covers concretely — trailing characters, decimals, exponent notation, and surrounding whitespace — so an operator can predict the behaviour rather than infer it from one example.
- 3 The copy does not overstate: values that are well-formed integers but out of range (e.g. a negative
PORT) fail with a range error, which is a different message from a parse error. Do not collapse the two into one claim. - 4 No "known issue" pointer to Tighten integer parsing for numeric environment variables in loadConfig() #1991 or any tracker item is added — the copy stands on its own as a description of shipped behaviour.
- 5
npm run docs:buildpasses (the release-timeonBrokenAnchors: 'throw'build), verified locally rather than inferred from a green PR — docs-only PRs make the CI gates green by vacuity.
Notes
- Owner:
docs-writer. Docs-only change; no production code. - Do not start before Tighten integer parsing for numeric environment variables in loadConfig() #1991 merges. Written early enough that the reversal is not forgotten, following the Make the authentication rate limits configurable by environment variable #1970 → Document the auth rate-limit environment variables on the docs site #1990 precedent in this cluster, where a docs half was tracked as its own item rather than as an AC on the parent so the parent's Done status did not wait on a docs cycle.
- AC3 exists because Tighten integer parsing for numeric environment variables in loadConfig() #1991 's own AC1/AC6 conflict turned on exactly this distinction: a negative value is a valid number out of range, not an unparseable one, and the two produce different error messages by design. Docs that blur it would reintroduce the confusion the ruling on Tighten integer parsing for numeric environment variables in loadConfig() #1991 removed.
Activity
Metadata
Metadata
Assignees
Labels
Projects
- StatusBacklog