Skip to content

self-documenting DSL idea for buildingBlocks.js #3

@UniqueFool

Description

@UniqueFool

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions