-
Notifications
You must be signed in to change notification settings - Fork 5k
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 updated #2644
Documentation updated #2644
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good changes! Keep in mind that users reading the docs don't know how the library behaves for "else" cases. If you specify a condition such as "if the address isn't available locally, X happens", the opposite needs to be implicitly clear or specified. Example logic: "[for all cases, Y happens], [only] if the address isn't available locally, X happens."
Description
The module constructors where not consistently described.
Fixes #2534 #2514 #2494 #2490 #2383
Type of change
Checklist:
npm run test
in the root folder with success and extended the tests if necessary.npm run build
in the root folder and tested it in the browser and with node.npm run dtslint
in the root folder and tested that all my types are correct