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

self-documenting DSL idea for buildingBlocks.js #3

Open
UniqueFool opened this issue May 19, 2016 · 2 comments
Open

self-documenting DSL idea for buildingBlocks.js #3

UniqueFool opened this issue May 19, 2016 · 2 comments

Comments

@UniqueFool
Copy link

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

@omphalos
Copy link
Owner

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

@UniqueFool
Copy link
Author

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

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

2 participants