-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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
chore: mark non-public APIs as @internal #2100
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Do we want to mark the Error classes |
My thinking:
|
Ok, sounds good |
e1a804e
to
c8af15a
Compare
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
R: @mmalerba
Disables the
stripInternal
TypeScript option (which omits@internal
symbols from the.d.ts
files) and uses the@internal
JsDoc to mark classes as non-public. This will tell our docs generation that this isn't a public API that needs to be documented.This is mainly for symbols where we don;t want to start them with an underscore (such as for class names) or for symbols that already have an underscored version (rare in our codebase).