sig icon indicating copy to clipboard operation
sig copied to clipboard

Adding example code to docs

Open okwme opened this issue 5 years ago • 1 comments

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 (https://github.com/TypeStrong/typedoc/issues/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 avatar Apr 02 '20 10:04 okwme

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 (https://github.com/cosmos/cosmos-sdk/issues/4705)

okwme avatar Apr 02 '20 10:04 okwme