docs(hud): describe the character-only summary cap and trim comments

This commit is contained in:
German Khokhlov committed 2026-11-03 14:34:32 +04:00
1 parent 33381c5981
commit ab8691383b
4 files changed
+12 -14

No files matched your search

+3 -5
View File
@@ -120,11 +120,9 @@ const FEED_STATE_LABELS = Object.freeze({
});
/**
* A summary line with its feed-state warning in the active language, e.g.
* `UNAVAILABLE | <text> | LIVE AIS VESSELS`. The state word leads so the
* one-line readout never clips it; the layer names trail so they never push
* the text out. State ids and layer names stay English in layer data; only
* this line translates them.
* A summary line with its translated warning:
* `UNAVAILABLE | <text> | LIVE AIS VESSELS`. The state leads so a narrow
* readout never clips it; the layer names trail so they never push out the text.
*/
function withProvenance(text, provenance) {
if (!provenance) return text;
+2 -2
View File
@@ -78,7 +78,7 @@ export const HUD_SUMMARY_MAX_CHARS = 80;
/** feedState values the model may return besides null. */
export const HUD_SUMMARY_FEED_STATES = SNAPSHOT_FEED_STATES;
/** Responses API structured output: the five words plus the canonical state. */
/** Responses API structured output: the summary plus the canonical state. */
export const HUD_SUMMARY_RESPONSE_FORMAT = Object.freeze({
type: 'json_schema',
name: 'hud_summary',
@@ -114,7 +114,7 @@ const SUMMARY_LANGUAGES = Object.freeze({
'zh-Hant': 'Chinese in Traditional characters (mainland wording)',
});
/** Scripts written without spaces, where five words do not apply. */
/** Scripts written without spaces, capped in characters instead of words. */
const UNSPACED_LOCALES = /^(?:ja|zh)(?:-|$)/;
/** Shipped locales not written in Latin letters. */