Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix spec for doc rendering (Part 1) #277

Merged
merged 4 commits into from
Dec 19, 2024

Conversation

alexandratran
Copy link
Contributor

@alexandratran alexandratran commented Dec 18, 2024

Since we've migrated to v2 of the OpenRPC spec parser for the API reference documentation, there are some missing/inconsistent/confusing details displayed in the rendered docs. This PR tweaks the spec param names, descriptions, etc. for the following methods to make the rendered docs more clear and consistent:

  • wallet_addEthereumChain
  • wallet_switchEthereumChain
  • wallet_getPermissions
  • wallet_requestPermissions
  • wallet_revokePermissions
  • personal_sign

The remaining methods will be addressed in future PRs.

Fixes #278
See MetaMask/metamask-docs#1778

@alexandratran alexandratran changed the title Fix spec for doc rendering Fix spec for doc rendering (Part 1) Dec 18, 2024
@alexandratran alexandratran marked this pull request as ready for review December 18, 2024 19:32
@alexandratran alexandratran requested a review from a team as a code owner December 18, 2024 19:32
@alexandratran alexandratran requested a review from jiexi December 19, 2024 18:51
@alexandratran alexandratran merged commit a19e6db into MetaMask:main Dec 19, 2024
7 checks passed
@alexandratran alexandratran deleted the fix-descriptions branch December 20, 2024 01:26
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.

Clarify permission object properties
2 participants