Skip to content

docs(types): correct thrown-http-error.ts doc comment for #8634's re-point - #8847

Merged
qq9340100 merged 1 commit into
mainfrom
claude/issue-8810-thrown-http-error-doccomment
Aug 15, 2026
Merged

docs(types): correct thrown-http-error.ts doc comment for #8634's re-point#8847
qq9340100 merged 1 commit into
mainfrom
claude/issue-8810-thrown-http-error-doccomment

Conversation

@qq9340100

Copy link
Copy Markdown
Collaborator

Fixes#8810

What changed

packages/types/src/thrown-http-error.ts's TSDoc for ThrownHttpError.declaredStatus, under "Why status cannot answer this", described the pre-field fallback-probe workaround (resolveThrownHttpError(e, 0).status !== 0) as "still spelled by hand in packages/rest's publish-classification suite". PR #8814 (closing #8634) re-pointed both call sites in that suite at declaredStatus directly, so that trailing clause is no longer true — nothing in the repo hand-spells the sentinel anymore.

Corrected the sentence to name the current call-site spelling instead of the stale one, so a future reader can check it against the code with one grep:

resolveThrownHttpError(error).declaredStatus !== undefined

(verified live at packages/rest/src/package-publish-status-classification.test.ts:405).

Docs-only TSDoc edit — no production/runtime change, no .describe()/schema doc, no generated-artifact consequence.

Scope

Per the card's ruling, file surface is packages/types/src/thrown-http-error.ts only — the one stale sentence, nothing else in the surrounding doc block touched. packages/rest's publish-classification suite (already re-pointed by #8814) is untouched, per the ruling.

Premise re-verification

Re-located the stale line by content rather than trusting the :88 line number cited in the card (the file has taken merges since). Confirmed on this branch's base (origin/main @ 6b6b606c5) that the sentence was still present and still false — the two call sites in package-publish-status-classification.test.ts already read declaredStatus (7 hits for declaredStatus in thrown-http-error.ts, 6 in the test file), matching the 09:05Z unlock-scan comment on the issue.

Tests

At HEAD c55539c05:

  • pnpm --filter '@objectstack/types^...' build (dependency closure — @objectstack/spec): success.
  • pnpm --filter '@objectstack/types' build: success.
  • pnpm --filter '@objectstack/types' typecheck: exit 0.
  • pnpm --filter '@objectstack/types' test -- --maxWorkers=2: Test Files 12 passed (12), Tests 337 passed (337), exit 0.
  • pnpm check:nul-bytes: OK (5855 tracked files scanned, no raw control bytes).
  • node scripts/pm/dispatch-gates.mjs packages/types/src/thrown-http-error.ts: no check family names this path specifically; no new error code, no fake engine, no test-file edit, no i18n-extract package touched — nothing else applies.

Changeset: intentionally omitted (skip-changeset label applied) — comment-only edit, no user-visible behavior. Matches the precedent set by #8814 (the sibling PR for #8634, same "comment-adjacent, no production change" shape), which also carried skip-changeset.


Generated by Claude Code

…point
The TSDoc for ThrownHttpError.declaredStatus said the fallback-probe
workaround (`resolveThrownHttpError(e, 0).status !== 0`) was "still
spelled by hand in packages/rest's publish-classification suite". PR
#8814 (closing #8634) re-pointed both call sites in that suite at
`declaredStatus` directly, so the clause is now false. Corrected it to
name the current call-site spelling instead.
Fixes#8810
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NaS1PAHJcPfAA2acnV53Tn
@qq9340100qq9340100 added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Aug 15, 2026 — with Claude
@vercel

vercelBot commented Aug 15, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
objectstackIgnoredIgnoredAug 15, 2026 9:19am

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 1 package(s): @objectstack/types.

1 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:

  • content/docs/plugins/packages.mdx(via @objectstack/types)

Advisory only. To re-verify, run the docs-accuracy-audit workflow scoped to these files:
node scripts/docs-audit/affected-docs.mjs origin/main → pass the list as args.docs.

@qq9340100
qq9340100 marked this pull request as ready for review August 15, 2026 09:34
@qq9340100
qq9340100 added this pull request to the merge queueAug 15, 2026
Merged via the queue into main with commit 30584aeAug 15, 2026
30 checks passed
@qq9340100
qq9340100 deleted the claude/issue-8810-thrown-http-error-doccomment branch August 15, 2026 09:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/xsskip-changesetPR has no user-facing published change; bypasses the changeset gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

thrown-http-error.ts:88's doc comment will say the sentinel is "still spelled by hand" after #8634 removes it

2 participants

@qq9340100@claude