Skip to content
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

Merged
merged 2 commits into from
Dec 13, 2016

Conversation

jelbourn
Copy link
Member

@jelbourn jelbourn commented Dec 7, 2016

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).

@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Dec 7, 2016
Copy link
Contributor

@kara kara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mmalerba
Copy link
Contributor

mmalerba commented Dec 8, 2016

Do we want to mark the Error classes @internal? I would think we'd want those in the documentation so people know what kind of errors to expect

@jelbourn
Copy link
Member Author

jelbourn commented Dec 8, 2016

@mmalerba

My thinking:

  • You never want to preemptively see the errors in the docs
  • There's nothing to do with the error classes- they're just containers for the string messages.
  • I think the docs are better off saying what is supported instead of listing the errors that can be thrown.

@mmalerba
Copy link
Contributor

mmalerba commented Dec 8, 2016

Ok, sounds good

@mmalerba mmalerba added the action: merge The PR is ready for merge by the caretaker label Dec 8, 2016
@jelbourn jelbourn added pr: needs rebase and removed action: merge The PR is ready for merge by the caretaker labels Dec 13, 2016
@jelbourn jelbourn added action: merge The PR is ready for merge by the caretaker and removed pr: needs rebase labels Dec 13, 2016
@jelbourn jelbourn merged commit 473752b into angular:master Dec 13, 2016
@jelbourn jelbourn deleted the internal-apis branch September 13, 2017 04:35
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 7, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants