Skip to content

docs: update controller-utils/isValidHexAddress to match reality#1308

Merged
legobeat merged 2 commits intoMetaMask:mainfrom
legobeat:docs-fix-isValidHexAddress
May 3, 2023
Merged

docs: update controller-utils/isValidHexAddress to match reality#1308
legobeat merged 2 commits intoMetaMask:mainfrom
legobeat:docs-fix-isValidHexAddress

Conversation

@legobeat
Copy link
Contributor

@legobeat legobeat commented May 2, 2023

Description

  • The jsdoc references non-existent parameter and behavior. This updates the doc to match reality.

  • Minor rewrite to make it clear that input is left unmodified.

Changes

  • FIXED: controller-utils: isValidHexAddress doesn't describe actual behavior

References

Originally added in 82386c4, seemingly reflecting a past and forgotten image of how things would have been.

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation for new or updated code as appropriate (note: this will usually be JSDoc)
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate

@legobeat legobeat marked this pull request as ready for review May 2, 2023 23:06
@legobeat legobeat requested a review from a team as a code owner May 2, 2023 23:06
Copy link
Member

@Gudahtt Gudahtt left a comment

Choose a reason for hiding this comment

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

LGTM!

@legobeat legobeat merged commit 9d44801 into MetaMask:main May 3, 2023
Gudahtt added a commit that referenced this pull request May 3, 2023
…-rebased

* origin/main:
  docs: update controller-utils/isValidHexAddress to match reality (#1308)
  keyring-controller: validate from-address in signTypedMessage (#1293)
  NetworkController: Fix chain IDs in tests (#1307)
  NetworkController: Normalize INFURA_NETWORKS array (#1306)
MajorLift pushed a commit that referenced this pull request Oct 11, 2023
MajorLift pushed a commit that referenced this pull request Oct 11, 2023
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