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
Since these are used on jsr.io for documentation (but even for deno doc or other doc generators), it'd be nice to add a few rules to lint comment docs like:
no-undocumented-exported-member: All exported members should have a doc comment:
exportfunctionbad(){}/** This function does stuff. */exportfunctiongood(){}
sentence-doc-comment: All single line doc comment should starts with an uppercase letter and ends with a final dot.
/** this function does stuff */exportfunctionbad(){}/** This function does stuff. */exportfunctiongood(){}
example-in-doc-comment: All multiline doc comment should contain an example (maybe make this one optional ?)
/** * This function does stuff. * * Lorem ipsum... * Blah blah blah... */exportfunctionbad(){}/** * This function does stuff. * * Lorem ipsum... * Blah blah blah... * * @example * ```ts * good() * ``` */exportfunctiongood(){}
The text was updated successfully, but these errors were encountered:
Since these are used on jsr.io for documentation (but even for
deno doc
or other doc generators), it'd be nice to add a few rules to lint comment docs like:no-undocumented-exported-member
: All exported members should have a doc comment:sentence-doc-comment
: All single line doc comment should starts with an uppercase letter and ends with a final dot.example-in-doc-comment
: All multiline doc comment should contain an example (maybe make this one optional ?)The text was updated successfully, but these errors were encountered: