API doc cleanup for decorators by jbogarthyde · Pull Request #31377 · angular/angular

jbogarthyde · 2019-07-01T20:55:00Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

Bugfix
Feature
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
angular.io application / infrastructure changes
Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Makes descriptions parallel, cleans up styles and formats to be consistent.
Mostly for decorators, but some other API issues that were reported.

Does this PR introduce a breaking change?

Yes
No

mary-poppins · 2019-07-01T21:02:33Z

You can preview 4fb4ff3 at https://pr31377-4fb4ff3.ngbuilds.io/.

mary-poppins · 2019-07-01T21:24:04Z

You can preview f2ed881 at https://pr31377-f2ed881.ngbuilds.io/.

mary-poppins · 2019-07-01T21:58:06Z

You can preview 971dc01 at https://pr31377-971dc01.ngbuilds.io/.

mary-poppins · 2019-07-01T22:37:29Z

You can preview f76f08b at https://pr31377-f76f08b.ngbuilds.io/.

IgorMinar

great improvements! thank you

I left a few comments / suggestions.

IgorMinar · 2019-07-01T23:33:22Z

does this region actually exist? I don't see it defined in the provider_spec.ts file.

I just noticed that ConstructorProvider is not exported from @angular/core at all (this makes it inaccessible to developers for direct interaction but allows type inference and typechecking to work just fine - meaning that developers would usually not complain about the lack of exporting but the docs for this symbol are missing on angular.io)

can you please fix this my exporting the symbol from packages/core/src/di/index.t and update tools/public_api_guard/core/core.d.ts to reflect the adition?

I can update the index, but I don't have access to the golden file. I've asked George to do it.

I foudn out there were a few more missing, so added them all (on a separate commit): 567e92b

mary-poppins · 2019-07-02T15:51:25Z

You can preview 01ddfc4 at https://pr31377-01ddfc4.ngbuilds.io/.

mary-poppins · 2019-07-02T15:51:47Z

You can preview 967f440 at https://pr31377-967f440.ngbuilds.io/.

mary-poppins · 2019-07-02T16:29:11Z

You can preview c25a0f9 at https://pr31377-c25a0f9.ngbuilds.io/.

mary-poppins · 2019-07-02T17:07:30Z

You can preview c3dd1ff at https://pr31377-c3dd1ff.ngbuilds.io/.

mary-poppins · 2019-07-02T22:00:32Z

You can preview d457932 at https://pr31377-d457932.ngbuilds.io/.

mary-poppins · 2019-07-02T22:02:52Z

You can preview f1e57b8 at https://pr31377-f1e57b8.ngbuilds.io/.

ngbot · 2019-07-03T15:07:02Z

I see that you just added the PR action: merge label, but the following checks are still failing:
     status "cla/google" is failing
     status "ci-codefresh-bazel" is failing
     missing required labels: cla: yes
     forbidden labels detected: cla: no
     status "google3" is pending
     1 pending code review

If you want your PR to be merged, it has to pass all the CI checks.

If you can't get the PR to a green state due to flakes or broken master, please try rebasing to master and/or restarting the CI job. If that fails and you believe that the issue is not due to your change, please contact the caretaker and ask for help.

jbogarthyde · 2019-07-03T15:07:34Z

Please fix the CLA and re-run codefresh.

mary-poppins · 2019-07-03T15:15:35Z

You can preview 4a76e3c at https://pr31377-4a76e3c.ngbuilds.io/.

mary-poppins · 2019-07-03T15:35:44Z

You can preview 3e38ced at https://pr31377-3e38ced.ngbuilds.io/.

mary-poppins · 2019-07-03T16:17:08Z

You can preview e6a1678 at https://pr31377-e6a1678.ngbuilds.io/.

… types Some of the provider interfaces that the [Provider][1] and [StaticProvider][2] types comprise were not exported from [@angular/core][3]. As a result, the docs for these symbols did not appear on angular.io (even though both `Provider` and `StaticProvider` are part of the public API. (See, also, angular#31377 (comment).) This commit fixes it by exporting all necessary provider interfaces. [1]: https://github.com/angular/angular/blob/9e34670b2/packages/core/src/di/interface/provider.ts#L365-L366 [2]: https://github.com/angular/angular/blob/9e34670b2/packages/core/src/di/interface/provider.ts#L283-L284 [3]: https://github.com/angular/angular/blob/9e34670b2/packages/core/src/di/index.ts#L23

mary-poppins · 2019-07-08T15:26:14Z

You can preview 742b170 at https://pr31377-742b170.ngbuilds.io/.

googlebot · 2019-07-08T16:51:08Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

ℹ️ Googlers: Go here for more info.

PR Close #31377

… types (#31377) Some of the provider interfaces that the [Provider][1] and [StaticProvider][2] types comprise were not exported from [@angular/core][3]. As a result, the docs for these symbols did not appear on angular.io (even though both `Provider` and `StaticProvider` are part of the public API. (See, also, #31377 (comment).) This commit fixes it by exporting all necessary provider interfaces. [1]: https://github.com/angular/angular/blob/9e34670b2/packages/core/src/di/interface/provider.ts#L365-L366 [2]: https://github.com/angular/angular/blob/9e34670b2/packages/core/src/di/interface/provider.ts#L283-L284 [3]: https://github.com/angular/angular/blob/9e34670b2/packages/core/src/di/index.ts#L23 PR Close #31377

PR Close #31377

angular-automatic-lock-bot · 2019-09-15T07:20:42Z

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

jbogarthyde requested a review from IgorMinar as a code owner July 1, 2019 20:55

jbogarthyde requested a review from a team July 1, 2019 20:55

googlebot added the cla: yes label Jul 1, 2019

jbogarthyde added aio: preview target: patch This PR is targeted for the next patch release type: bug/fix labels Jul 1, 2019

ngbot Bot added this to the needsTriage milestone Jul 1, 2019

IgorMinar approved these changes Jul 1, 2019

View reviewed changes

IgorMinar added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Jul 1, 2019

devversion reviewed Jul 2, 2019

View reviewed changes

Comment thread packages/core/src/metadata/di.ts Resolved

kapunahelewong added risk: low effort1: hours freq1: low labels Jul 2, 2019

ngbot Bot modified the milestones: needsTriage, Backlog Jul 2, 2019

jbogarthyde force-pushed the jb-apidoc-decorators branch 2 times, most recently from 01ddfc4 to 967f440 Compare July 2, 2019 15:45

gkalpak force-pushed the jb-apidoc-decorators branch from c3dd1ff to 0db38da Compare July 2, 2019 21:09

jbogarthyde requested a review from a team July 2, 2019 21:09

jbogarthyde force-pushed the jb-apidoc-decorators branch from f1e57b8 to 4a76e3c Compare July 3, 2019 15:09

jbogarthyde removed the action: merge The PR is ready for merge by the caretaker label Jul 3, 2019

jbogarthyde force-pushed the jb-apidoc-decorators branch from 4a76e3c to 3e38ced Compare July 3, 2019 15:29

jbogarthyde force-pushed the jb-apidoc-decorators branch from 3e38ced to e6a1678 Compare July 3, 2019 16:06

gkalpak and others added 2 commits July 8, 2019 08:18

docs: api doc cleanup

742b170

jbogarthyde force-pushed the jb-apidoc-decorators branch from e6a1678 to 742b170 Compare July 8, 2019 15:18

jasonaden added cla: yes and removed cla: no labels Jul 8, 2019

jasonaden closed this in 35f8bfc Jul 8, 2019

jasonaden pushed a commit that referenced this pull request Jul 8, 2019

docs: api doc cleanup (#31377)

40aaa42

PR Close #31377

jasonaden pushed a commit that referenced this pull request Jul 8, 2019

docs: api doc cleanup (#31377)

0e53e8f

PR Close #31377

jbogarthyde deleted the jb-apidoc-decorators branch July 9, 2019 15:55

angular-automatic-lock-bot Bot locked and limited conversation to collaborators Sep 15, 2019

Conversation

jbogarthyde commented Jul 1, 2019

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Uh oh!

mary-poppins commented Jul 1, 2019

Uh oh!

mary-poppins commented Jul 1, 2019

Uh oh!

mary-poppins commented Jul 1, 2019

Uh oh!

mary-poppins commented Jul 1, 2019

Uh oh!

IgorMinar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

IgorMinar Jul 1, 2019

Choose a reason for hiding this comment

Uh oh!

jbogarthyde Jul 2, 2019

Choose a reason for hiding this comment

Uh oh!

gkalpak Jul 2, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mary-poppins commented Jul 2, 2019

Uh oh!

mary-poppins commented Jul 2, 2019

Uh oh!

mary-poppins commented Jul 2, 2019

Uh oh!

mary-poppins commented Jul 2, 2019

Uh oh!

mary-poppins commented Jul 2, 2019

Uh oh!

mary-poppins commented Jul 2, 2019

Uh oh!

ngbot Bot commented Jul 3, 2019

Uh oh!

jbogarthyde commented Jul 3, 2019

Uh oh!

mary-poppins commented Jul 3, 2019

Uh oh!

mary-poppins commented Jul 3, 2019

Uh oh!

mary-poppins commented Jul 3, 2019

Uh oh!

mary-poppins commented Jul 8, 2019

Uh oh!

googlebot commented Jul 8, 2019

Uh oh!

angular-automatic-lock-bot Bot commented Sep 15, 2019

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

gkalpak Jul 2, 2019 •

edited

Loading