This package provides Text-Runner
actions for verifying the documentation of NPM modules exporting shared
Text-Runner actions. Let's say you work on an NPM module called
textrun-cooking that provides the action recipe. Here is how you would
document individual actions inside this NPM module.
The action/name-full action verifies the
documented full name of an exported action, which includes the NPM package name
without its textrun- prefix. In our example, we would use it like this:
The <b type="action/name-full">cooking/recipe</b> action verifies recipes.The action/name-short action is similar to action/name-full except that the documented action name does not contain the package name. In our example, we would use it like this:
The <b type="action/name-short">recipe</b> action verifies recipes.