Skip to content

docs: name the referent in the drift-guard array-order comment - #15

Merged
bloxster merged 1 commit into
mainfrom
docs/guard-comment-referent
Aug 3, 2026
Merged

bloxster merged 1 commit into
mainfrom
docs/guard-comment-referent

Conversation

@bloxster

Copy link
Copy Markdown
Contributor

Comment-only follow-up, keeping the three drift-guard copies byte-identical.

Copilot noted on erigontech/erigon#22772 that "Order matters in some ... and not in others" leaves some/others without an explicit referent. Now reads:

// Arrays keep their order. Order is meaningful in some arrays (a `paths` entry
// is an ordered fallback list) but not in others (`lib`, `types`).

No code change. Propagated here because the docs-sites alignment routine hashes the guard's content — a wording fix in one repo alone shows up as drift (GUARDSUM).

🤖 Generated with Claude Code

"Order matters in some ... and not in others" left some/others without an
explicit referent. Say "some arrays" / "others". Flagged by Copilot on
erigontech/erigon#22772.

Comment-only; the three copies stay byte-identical (normalised).

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR makes a comment-only clarification in the tsconfig drift-guard script so the “some/others” referents are explicit, while keeping the guard text aligned across repositories for drift hashing (GUARDSUM).

Changes:

  • Clarifies the array-order rationale by explicitly naming which arrays have meaningful order (paths) vs not (lib, types).
  • Preserves the existing drift-guard behavior (no functional code changes).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bloxster
bloxster merged commit 3c6fca2 into main Aug 3, 2026
2 checks passed
@bloxster
bloxster deleted the docs/guard-comment-referent branch August 3, 2026 14:19
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