docs(Strings): correct escapeJSON note to reflect actual behavior

[Forostovec]

Updated the escapeJSON() docstring in contracts/utils/Strings.sol. The previous NOTE incorrectly claimed all Unicode characters are escaped. The function only escapes JSON special characters, matching the implementation and tests.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 8892b06

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The change updates documentation in the escapeJSON function to clarify the specific JSON special characters it escapes (U+0008, U+0009, U+000A, U+000C, U+000D, U+0022, U+005C) rather than implying all Unicode code points are escaped. The underlying code implementation remains unchanged, with no modifications to control flow, error handling, or public declarations.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: correcting the escapeJSON documentation to reflect its actual behavior.
Description check	✅ Passed	The description is directly related to the changeset, explaining what was corrected in the documentation and why.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce5e6ed and 8892b06.

📒 Files selected for processing (1)

• contracts/utils/Strings.sol (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)

• GitHub Check: Redirect rules - solidity-contracts
• GitHub Check: Header rules - solidity-contracts
• GitHub Check: slither
• GitHub Check: tests
• GitHub Check: coverage
• GitHub Check: tests-foundry
• GitHub Check: tests-upgradeable
• GitHub Check: Pages changed - solidity-contracts
• GitHub Check: halmos

🔇 Additional comments (1)

contracts/utils/Strings.sol (1)

460-462: Documentation accurately reflects the implementation.

The updated NOTE correctly specifies the seven JSON special characters that are escaped (U+0008, U+0009, U+000A, U+000C, U+000D, U+0022, U+005C), matching both the SPECIAL_CHARS_LOOKUP bitmask (lines 19–26) and the escape logic (lines 471–482). The reference to ECMAScript's JSON.stringify behavior is accurate, and the clarification that arbitrary Unicode code points are not escaped addresses the previous documentation's imprecision.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}