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

Adding example code to docs #11

Open
okwme opened this issue Apr 2, 2020 · 1 comment
Open

Adding example code to docs #11

okwme opened this issue Apr 2, 2020 · 1 comment

Comments

@okwme
Copy link
Contributor

okwme commented Apr 2, 2020

Seems like it should be possible for typedoc to do this automatically but doesn't seem to be a supported feature. I see there's also a command for including examples in JSDoc format but typedoc doesn't support it. Instead they suggest including as code snippets, which sounds like it would also work (TypeStrong/typedoc#135).

Just think it would be nice for example on the tx page to see all of the types actually constructed together once as an example of the object. I find it a lot easier to confirm what you're doing is correct if you're able to just compare the results.

@okwme
Copy link
Contributor Author

okwme commented Apr 2, 2020

Might also make it easier to link main cosmos docs to sig docs in support of a better description of how transactions and messages are constructed (cosmos/cosmos-sdk#4705)

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