You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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
The text was updated successfully, but these errors were encountered: