Release 0.2.1: precisely scope "cosmetic" — string literals trip the gate (#21)#26
Merged
Merged
Conversation
Release 0.2.1 (docs-only). The README framed Surface as ignoring "cosmetic" changes, which led users to expect string/copy edits to be ignored — they are not, since a literal value is part of the hashed AST. Clarify that "cosmetic" means only whitespace, comments, and consistent renames, add a FAQ entry, and point at narrower anchoring so copy churn doesn't re-open a claim. The magnitude-aware policy / --ignore-literals knob (the feature half of #21) remains tracked for 0.3.0; refs #21. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs-only patch release. Addresses the documentation half of #21 (the magnitude/
--ignore-literalsfeature stays in the 0.3.0 milestone).Why
The README framed Surface as ignoring "cosmetic" changes (formatting/comments/renames), which led a dogfooding user to expect string/copy edits to be ignored too. They aren't — a literal value is part of the hashed AST, so editing a string inside an anchored span correctly fires a divergence. The mismatch was in the docs, not the behavior.
What
docs/examples.mdand the authoring guide already enumerated "cosmetic" precisely and showed a literal change firing, so they were left as-is.Refs #21 (not closed — feature knob is 0.3.0). No code change;
surf check/lintgreen; binary behavior unchanged.🤖 Generated with Claude Code