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

Documentation or friendly error messages is required for configuration #671

Open
homura opened this issue Apr 15, 2024 · 0 comments
Open

Comments

@homura
Copy link
Collaborator

homura commented Apr 15, 2024

We have recently received feedback regarding the usage of non-intuitive configurations. As a result, it has been suggested that we include documentation or friendly error messages to make it easier to debug

Some of the areas that have been identified as potentially confusing include:

  • the last optional parameter { config?: Config } in many methods
  • initializeConfig for rewriting the default mainnet configuration with a custom one
  • refreshScriptConfigs for refreshing configuration at the beginning to avoid outdated type id
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

No branches or pull requests

1 participant