Skip to content

Commit

Permalink
docs: addMetamaskNetwork description made clearer
Browse files Browse the repository at this point in the history
Great work with this library :)

While using it, I noticed that the documentation of addMetamaskNetwork could've been a little bit clearer - this method not only adds a new network but also switches to it in the process.
Ideally, this method should also be named just like you've named 'allowMetamaskToAddAndSwitchNetwork' which clearly tells what the function would do.
  • Loading branch information
dewanshparashar authored Sep 29, 2022
1 parent dd4e14a commit c043c3b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion support/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ declare namespace Cypress {
*/
getNetwork(): Chainable<Subject>;
/**
* Add network in metamask
* Add network in metamask (and also switch to the newly added network)
* @example
* cy.addMetamaskNetwork({networkName: 'name', rpcUrl: 'https://url', chainId: '1', symbol: 'ETH', blockExplorer: 'https://url', isTestnet: true})
*/
Expand Down

0 comments on commit c043c3b

Please sign in to comment.