docs: clarify destination conversion comment #27

Merged
jercik merged 3 commits from docs/destination-conversion-comment into main 2026-10-03 21:34:37 +00:00
Owner

Clarifies the destination-conversion comment raised in #26 without changing the regexp or URL behavior.

Clarifies the destination-conversion comment raised in [#26](https://code.j4k.dev/j4k-oss/review-wrapper/pulls/26#issuecomment-110702) without changing the regexp or URL behavior.
docs: clarify destination conversion comment
All checks were successful
commit-msg / commitlint (pull_request) Successful in 28s
Checks / quality-checks (pull_request) Successful in 58s
Review / Review (pull_request_target) Successful in 2m51s
229c5803be

Review 01M41T3K12G24HREKD7HTDVQ0E — head 69dfc1d9e0777fd4adb7781603b3f932d189b4d2

Review — j4k-oss/review-wrapper @ e699438196

Scope: diff against base tree c032678d1064
Status: dispatched — coverage complete (4/4 slots terminal)
Facts: current review-wide projection

Computed under:

{
  "abandonment": "abandonment-v1",
  "anchor_recipe": 1,
  "batch_policy": "batch-v1",
  "coverage": "coverage-v3",
  "dispatch_policy": "dispatch-v2",
  "grounder_version": 1,
  "grounding_read_rule": "grounding-read-v1",
  "promotion_policy": "promotion-v1",
  "report": "report-v3",
  "tally": "tally-v1",
  "triage_settle": "triage-settle-v2"
}

Findings (0)

No findings survived.

Reviewed:

  • general-bug (whole/default): no-claims
  • writing-quality (whole/default): no-claims
  • test-trimming (whole/default): no-claims
  • restated-sets (whole/default): no-claims

Other claims

  • grounding-pending (0)
  • ungrounded (0)
  • rejected (0)
  • duplicate-of (0)
  • unadjudicated (0)

Coverage

Coverage pass: 01M41T3K2V97XH65KWAEAN5J5M
Accounting: complete
Slot health: healthy

lens part arm unit status runs loss
general-bug whole default no-claims 1 no
writing-quality whole default no-claims 1 no
test-trimming whole default no-claims 1 no
restated-sets whole default no-claims 1 no
<!-- review:summary --> **Review** `01M41T3K12G24HREKD7HTDVQ0E` — head `69dfc1d9e0777fd4adb7781603b3f932d189b4d2` # Review — j4k-oss/review-wrapper @ e69943819640 Scope: diff against base tree `c032678d1064` Status: dispatched — coverage complete (4/4 slots terminal) Facts: current review-wide projection Computed under: ```json { "abandonment": "abandonment-v1", "anchor_recipe": 1, "batch_policy": "batch-v1", "coverage": "coverage-v3", "dispatch_policy": "dispatch-v2", "grounder_version": 1, "grounding_read_rule": "grounding-read-v1", "promotion_policy": "promotion-v1", "report": "report-v3", "tally": "tally-v1", "triage_settle": "triage-settle-v2" } ``` ## Findings (0) No findings survived. Reviewed: - general-bug (whole/default): no-claims - writing-quality (whole/default): no-claims - test-trimming (whole/default): no-claims - restated-sets (whole/default): no-claims ## Other claims - grounding-pending (0) - ungrounded (0) - rejected (0) - duplicate-of (0) - unadjudicated (0) ## Coverage Coverage pass: 01M41T3K2V97XH65KWAEAN5J5M Accounting: complete Slot health: healthy | lens | part | arm | unit status | runs | loss | | --- | --- | --- | --- | --- | --- | | general-bug | whole | default | no-claims | 1 | no | | writing-quality | whole | default | no-claims | 1 | no | | test-trimming | whole | default | no-claims | 1 | no | | restated-sets | whole | default | no-claims | 1 | no |
@ -18,3 +18,3 @@
const PARSE_MAX = 4096;
/** A backslash escape, or a character only an angle-bracket destination may hold. */
/** Backslash escapes to preserve and characters this converter encodes or escapes when

low — Destination matcher comment says all backslash escapes are preserved

I read the changed comment, plainDestination immediately below it, parseLiteralRanges, and the destination case in neutralize-html.test.ts. The regex matches escaped punctuation, including escaped angle brackets. In plainDestination, its two-character match branch percent-encodes an escaped angle bracket and returns other matched backslash escapes unchanged; the destination test expects a percent-encoded angle bracket. Calling the whole matched class backslash escapes to preserve therefore gives a maintainer the wrong rule when adjusting the matcher: one matched escape deliberately loses its backslash. The writing standard calls for verifiable wording. Replace the comment with: Backslash escapes to inspect and characters to encode or escape when converting an angle-bracket destination to a bare one. This keeps the matcher purpose without claiming every escape is preserved. The decisive evidence is the two-character match branch and the destination test. I did not run the test suite.

lens writing-quality · arm default · tally 1 valid / 0 invalid / 0 uncertain
claim 01M41RDXM89JJMVEFMKR8G9G13 of review 01M41RAK287E18Y3C0P75H89JT

<!-- review:claim:01M41RDXM89JJMVEFMKR8G9G13 --> **low** — Destination matcher comment says all backslash escapes are preserved > I read the changed comment, plainDestination immediately below it, parseLiteralRanges, and the destination case in neutralize-html.test.ts. The regex matches escaped punctuation, including escaped angle brackets. In plainDestination, its two-character match branch percent-encodes an escaped angle bracket and returns other matched backslash escapes unchanged; the destination test expects a percent-encoded angle bracket. Calling the whole matched class backslash escapes to preserve therefore gives a maintainer the wrong rule when adjusting the matcher: one matched escape deliberately loses its backslash. The writing standard calls for verifiable wording. Replace the comment with: Backslash escapes to inspect and characters to encode or escape when converting an angle-bracket destination to a bare one. This keeps the matcher purpose without claiming every escape is preserved. The decisive evidence is the two-character match branch and the destination test. I did not run the test suite. lens `writing-quality` · arm `default` · tally 1 valid / 0 invalid / 0 uncertain claim `01M41RDXM89JJMVEFMKR8G9G13` of review `01M41RAK287E18Y3C0P75H89JT`
Author
Owner

Fixed in e942302182: the comment now describes backslash escapes to inspect, covering both preserved punctuation escapes and percent-encoded angle brackets without promising every backslash survives.

<!-- gh-feedback:reply-to:110834 --> Fixed in e9423021825e383f3aaaabd66f8a30b22eb779e0: the comment now describes backslash escapes to inspect, covering both preserved punctuation escapes and percent-encoded angle brackets without promising every backslash survives.
jercik marked this conversation as resolved
docs: distinguish inspected destination escapes
All checks were successful
commit-msg / commitlint (pull_request) Successful in 19s
Checks / quality-checks (pull_request) Successful in 33s
Review / Review (pull_request_target) Successful in 1m36s
e942302182
docs: integrate destination comment with merged URL fix
All checks were successful
commit-msg / commitlint (pull_request) Successful in 23s
Checks / quality-checks (pull_request) Successful in 47s
Review / Review (pull_request_target) Successful in 1m49s
69dfc1d9e0
jercik merged commit 12e4750450 into main 2026-10-03 21:34:37 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
j4k-oss/review-wrapper!27
No description provided.