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

docs(ChainType): fix docs for chaintype return value #626

Merged
merged 2 commits into from
Aug 2, 2021

Conversation

TarikGul
Copy link
Member

closes: [#624]

I updated the docs to reflect the actual return value of ChainType via polkadot-js.

The route this is associated with is /runtime/spec.

The enum ChainType has 4 variants:

- Live => null
- Development => null
- Local => null
- Custom => string

The old docs reflected that the return value is a string, but instead an object is returned with the key as one of the variants, and the value as null except when the variant custom is used, in which case a string will be the value.

@TarikGul TarikGul requested a review from emostov July 31, 2021 02:06
@TarikGul TarikGul merged commit f20b033 into master Aug 2, 2021
@TarikGul TarikGul deleted the tarik-fix-chaintype-doc branch August 2, 2021 23:54
@jsdw jsdw mentioned this pull request Aug 10, 2021
This pull request was closed.
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.

3 participants