-
Notifications
You must be signed in to change notification settings - Fork 54
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
@internal JSDoc tag #522
Comments
@mary-ext jsdoc specifies an |
I think it should, judging by the description of |
@mary-ext we have decided with the following: |
Sounds good! |
TypeScript has an option for stripping away internal-use declarations,
stripInternals
. It removes exported variables, public fields that are marked with@internal
in the doc comments.Useful in two cases:
filed as per this Discord message, but perhaps it needs a little more than just on the documentation side? (e.g. JSR needs to strip it too for npm usage, Deno needs to ignore it when it's in an external dependency, etc.)
The text was updated successfully, but these errors were encountered: