tendermint/sig

Adding example code to docs

Opened this issue · 1 comments

okwme commented

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 commented

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)