Skip to content

fix: rename simulation Cost placeholder to disambiguate UI vs runtime#531

Merged
chrisli30 merged 3 commits into
mainfrom
staging
May 3, 2026
Merged

fix: rename simulation Cost placeholder to disambiguate UI vs runtime#531
chrisli30 merged 3 commits into
mainfrom
staging

Conversation

@chrisli30
Copy link
Copy Markdown
Member

  • fix: rename simulation Cost placeholder to disambiguate UI vs runtime

"⛽ (cost estimated at deploy)" reads ambiguously — "at deploy" can be
parsed as a future-tense moment ("when you click deploy") or as a
reference to a UI step. The intent is the latter: the user sees the
real cost estimate at the Deploy step in the workflow builder, not
after the workflow runs.

Capitalize "Deploy" to flag it as the UI action and switch from
"estimated" to "shown" so the line reads concretely:

⛽ (cost shown at the Deploy step)

Updates Telegram + email formatters, tests, and the change-doc.

  • style: align trigger timestamp with simulation Cost line typography

The "May 3, 2026 at 4:53 AM UTC" timestamp in email's "What Triggered
This Workflow" section was indented under the trigger description and
used a smaller (14px) non-italic font, while the simulation Cost
placeholder ("⛽ (cost shown at the Deploy step)") sits at the
left margin in italic gray. Visually inconsistent for two pieces of
secondary metadata.

Match the typography: drop the 18px left indent, switch to 20px top
margin (matches the gap between section divs), drop the font-size
override, add font-style: italic. Both lines now share the same
italic-gray treatment.

"⛽ (cost estimated at deploy)" reads ambiguously — "at deploy" can be
parsed as a future-tense moment ("when you click deploy") or as a
reference to a UI step. The intent is the latter: the user sees the
real cost estimate at the **Deploy step** in the workflow builder, not
after the workflow runs.

Capitalize "Deploy" to flag it as the UI action and switch from
"estimated" to "shown" so the line reads concretely:

  ⛽ (cost shown at the Deploy step)

Updates Telegram + email formatters, tests, and the change-doc.
@claude
Copy link
Copy Markdown

claude Bot commented May 3, 2026

Code Review

Overview

Small, focused UI/copy fix across two notification formatters. The PR does two things:

  1. Renames the simulation cost placeholder from ⛽ (cost estimated at deploy)⛽ (cost shown at the Deploy step) for clarity
  2. Aligns the email trigger-timestamp typography with the cost placeholder (italic gray, no left indent)

Both changes are purely presentational with no logic modifications.


What's Done Well

  • Consistency: All occurrences of the old string are updated in lockstep — email formatter, Telegram formatter, tests, and the change-doc. No stale copies left behind.
  • Test updates: The four affected test assertions are all updated to match the new string. The negation test in TestFormatTelegramFromStructured_RunnerAndFees (checking that a deployed run does NOT show the simulation placeholder) is correctly updated too.
  • Scope discipline: No unrelated changes crept in.

Issues / Suggestions

1. Multi-line comment violates project style (summarizer_format_email.go:269-271)

// Same typographic treatment as the simulation Cost placeholder line
// (italic, gray, no left indent) — secondary metadata that visually
// flanks the primary content.

CLAUDE.md says: "Never write multi-paragraph docstrings or multi-line comment blocks — one short line max." The WHY here (visual alignment with the cost line) is non-obvious, so a comment is warranted — but it should collapse to one line:

// Italic-gray, no indent — matches the simulation Cost placeholder typography.

2. Typography change increases top margin significantly

Old: margin: 4px 0 0 18px → New: margin: 20px 0 0 0

The 4px → 20px jump is a meaningful visual spacing change that might look fine in isolation but could feel disconnected from the trigger description it annotates, depending on what element precedes it in the rendered email. Since there are no visual regression tests (acceptable for this kind of project), this is worth a quick eyeball in a real email client before merge.

3. Font size is now inherited (was explicitly 14px)

The old font-size: 14px is dropped. If the surrounding <p> or email template has a larger inherited font size, the timestamp will render bigger than before. Confirm the default context renders as intended.


Risk Assessment

Low risk. No logic changes, no data-path changes. The worst case is a minor visual regression in email layout.

One nit (comment length) and two things worth a visual sanity-check before merge. Otherwise clean.

@chrisli30 chrisli30 changed the title fix: simulation Cost placeholder copy + email timestamp typography fix: rename simulation Cost placeholder to disambiguate UI vs runtime May 3, 2026
…loy"

Future-tense + "before deploy" reads as a clear instruction (the user
will see the cost prior to clicking Deploy) without ambiguity around
what "deploy" means as a noun.

Replaces the prior "(cost shown at the Deploy step)" wording across
Telegram, email, tests, and the change-doc.
…deploy"

"Estimate" sets the right expectation — what the user sees at the
Deploy step is a forecast, not a fixed price. Imperative voice
("see ...") reads as a clear instruction.

Singular ("estimate") matches the actual UI: the Deploy step shows
one Cost line, not a list.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants