inductive.js icon indicating copy to clipboard operation
inductive.js copied to clipboard

self-documenting DSL idea for buildingBlocks.js

Open UniqueFool opened this issue 9 years ago • 2 comments

When I looked at buildingBlocks.js, I realized that it would be really useful if each buildingBlock could have an optional "description" string, that would make it possible to obtain context sensitive help for APIs that are not yet sufficiently documented elsewhere - in fact, each building block could even contain an actual example, so that this could be used for interactive troubleshooting - e.g. the register() helper at the top of buildingBlocks.js could then also add documentation related info for each building block added via express() to the object, so that this could be used for better troubleshooting, and even to help create/update documentation procedurally - i.e no DRY, because the docs would be part of the code, kinda like Python docstrings

UniqueFool avatar May 19 '16 15:05 UniqueFool

I like this idea a lot - it's really cool. I'll add this to my TODO list.

omphalos avatar May 19 '16 23:05 omphalos

great, I won't be spending too much time then documenting any of the buildingBlocks in the meantime ;-)

UniqueFool avatar May 19 '16 23:05 UniqueFool