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

Rename parameter for decodeData from keyName -> keyNameOrHex #491

Open
CJ42 opened this issue Nov 21, 2024 · 0 comments
Open

Rename parameter for decodeData from keyName -> keyNameOrHex #491

CJ42 opened this issue Nov 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@CJ42
Copy link
Collaborator

CJ42 commented Nov 21, 2024

Summary

The function decodeData can take the first parameter in the array entry in two forms:

  • either the key name as a plain word string like LSP3Profile (the name field in an ERC725Y JSON Schema`.
  • or the bytes32 hex string of the key (the key field in an ERC725Y JSON Schema).

However the generated docs + param name is only called keyName. This can be confusing for developers when hovering over the function in their IDE and seeing the parameter name and description (intellisense)

See the docs page for infos:

image
@CJ42 CJ42 added enhancement New feature or request documentation Improvements or additions to documentation labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant