Skip to content

docs: add types to public methods and getters/setters #9612

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

Merged
merged 1 commit into from
Jan 31, 2018
Merged

docs: add types to public methods and getters/setters #9612

merged 1 commit into from
Jan 31, 2018

Conversation

rafaelss95
Copy link
Contributor

@rafaelss95 rafaelss95 commented Jan 26, 2018

Part of #9558.

This:

  • Changes some incorrect docs;
  • Marks some inherited methods/variables' docs as private-docs as they can be caught by parent class after docs: show inherited properties #9299;
  • Put getters/setters and properties together to avoid duplicated docs;
  • Removes unnecessary docs for ControlValueAccessor methods API;
  • Removes unnecessary types for lifecycle hooks;
  • Adds missing types for methods/variables;

Relates to #8832.

cc @jelbourn.

I'm open to rephrase the title of this PR, feel free to suggest.

@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Jan 26, 2018
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Jan 26, 2018
@jelbourn
Copy link
Member

Passes internal presubmit, just needs rebase

@rafaelss95
Copy link
Contributor Author

Done, @jelbourn.

@josephperrott
Copy link
Member

@rafaelss95 Looks like a lint error due to having an unescaped HTML tag in a JSDoc.

@googlebot
Copy link

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this State. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

@googlebot googlebot added cla: no PR author must sign Google's Contributor License Agreement: https://opensource.google.com/docs/cla and removed cla: yes PR author has agreed to Google's Contributor License Agreement labels Jan 28, 2018
@rafaelss95
Copy link
Contributor Author

rafaelss95 commented Jan 28, 2018

Done, @josephperrott.

I messed up while I was rebasing and @googlebot removed the cla: yes label. Can you add it again?

@mmalerba mmalerba added cla: yes PR author has agreed to Google's Contributor License Agreement and removed cla: no PR author must sign Google's Contributor License Agreement: https://opensource.google.com/docs/cla labels Jan 29, 2018
@tinayuangao tinayuangao merged commit 3d2f709 into angular:master Jan 31, 2018
@rafaelss95 rafaelss95 deleted the missing-docs-1 branch March 5, 2018 02:15
@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 8, 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.

6 participants