Skip to content

Rename parameter for decodeData from keyName -> keyNameOrHex #491

Open

Description

@CJ42

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

Activity

  1. added
    enhancementNew feature or request
    documentationImprovements or additions to documentation
    on Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions