Clarified Comments for Better Code Understanding Update Address.sol

[0xwitty]

Description

This PR focuses on enhancing code clarity by adding more detailed comments to the functions verifyCallResultFromTarget and _revert. The aim is to improve understanding for future developers, especially when debugging or reviewing the code.

• Clarified the comment in verifyCallResultFromTarget:

  • Updated the comment to indicate that the contract check is performed only if the call is successful and there is no return data. This helps ensure that the logic around this check is more transparent.

  // only check if target is a contract if the call was successful and there is no return data

• Added a comment in the _revert function:

  • Explained the use of assembly for propagating the revert reason. This change ensures that the process of handling revert reasons is clearer for anyone maintaining the code.

  // Use assembly to revert with returndata, which is the easiest way to propagate revert reasons

These changes aim to improve the readability of the code without altering any functionality.

• Tests
• Documentation
• Changeset entry (run npx changeset add)

[changeset-bot]

⚠️ No Changeset found

Latest commit: d4e95f2

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