deno test --doc
: generated docs tests in JSDoc should it for naming (e.g. @example
, token name, etc.)
#25995
Labels
suggestion
suggestions for new features (yet to be agreed)
testing
related to deno test and coverage
Currently the
@example
JSdoc annotation can be used to title examples in generaed documentation.(Example
@std/fmt/bytes
)When using
deno doc --test
currently the name are auto-generated with the filename/lines, but for long files it makes it a bit cryptic to map them back easily.A solution would be to use the
@example
value (if defined) to set theDeno.test
name.Eventually, the name of the token could be used too (e.g. the name of the documented function, variable, etc.)
Maybe also there may be no need to put the full file url, as the
running X test from ./...
is relative, it'd be less verbose to not be an absolute url/path but just a relative oneThe text was updated successfully, but these errors were encountered: