Update Router API documentation by jbogarthyde · Pull Request #37980 · angular/angular

jbogarthyde · 2020-07-08T15:57:34Z

Edit descriptions, usage examples, and add links to be complete and consistent with API reference doc style

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

What kind of change does this PR introduce?

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?

Router API docs are incomplete and do not follow current standards.
Does not use terminology consistently or in accordance with guide usage.

Issue Number: N/A

What is the new behavior?

Adds links to guides and among members, adds, restructures, and edits descriptions of public members.

Does this PR introduce a breaking change?

Yes
No

mary-poppins · 2020-07-08T16:06:52Z

You can preview 8e4b631 at https://pr37980-8e4b631.ngbuilds.io/.

mary-poppins · 2020-07-08T16:42:24Z

You can preview 049a6fd at https://pr37980-049a6fd.ngbuilds.io/.

mary-poppins · 2020-07-08T17:44:05Z

You can preview 8e06739 at https://pr37980-8e06739.ngbuilds.io/.

mary-poppins · 2020-07-08T18:29:01Z

You can preview f32977e at https://pr37980-f32977e.ngbuilds.io/.

mary-poppins · 2020-07-08T19:15:06Z

You can preview 924df2e at https://pr37980-924df2e.ngbuilds.io/.

mary-poppins · 2020-07-08T20:34:14Z

You can preview ec00597 at https://pr37980-ec00597.ngbuilds.io/.

mary-poppins · 2020-07-08T20:58:09Z

You can preview abbfa49 at https://pr37980-abbfa49.ngbuilds.io/.

mary-poppins · 2020-07-08T21:38:01Z

You can preview 4bbd262 at https://pr37980-4bbd262.ngbuilds.io/.

jelbourn · 2020-07-14T20:57:06Z

I don't know why this PR is requesting public-api approvers because AFAICT it doesn't touch anything there. @atscott once you approve this PR feel free to ping me for global approval

petebacondarwin · 2020-07-14T21:01:10Z

@jelbourn it is because of this line here https://github.com/angular/angular/pull/37980/files?file-filters%5B%5D=.ts#diff-d4a2188410be78a020e88630cdafa20dL151

mary-poppins · 2020-07-15T14:54:42Z

You can preview 7ee48c6 at https://pr37980-7ee48c6.ngbuilds.io/.

mary-poppins · 2020-07-15T16:58:52Z

You can preview 3efead9 at https://pr37980-3efead9.ngbuilds.io/.

jelbourn

LGTM - using global-approvers because the public API change is removing a deprecation marker that wasn't supposed to be on that symbol in the first place

Reviewed-for: global-approvers

ngbot · 2020-07-16T15:28:45Z

I see that you just added the PR action: merge label, but the following checks are still failing:
     conflicts with base branch "master"
     status "google3" is pending
     3 pending code reviews

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.

Edit descriptions, usage examples, and add links to be complete and consistent with API reference doc style

mary-poppins · 2020-07-16T15:49:09Z

You can preview ce88f29 at https://pr37980-ce88f29.ngbuilds.io/.

Edit descriptions, usage examples, and add links to be complete and consistent with API reference doc style PR Close #37980

angular-automatic-lock-bot · 2020-08-20T16:16:59Z

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

Edit descriptions, usage examples, and add links to be complete and consistent with API reference doc style PR Close angular#37980

jbogarthyde added type: bug/fix comp: docs effort2: days freq2: medium area: router target: patch This PR is targeted for the next patch release risk: low labels Jul 8, 2020

jbogarthyde self-assigned this Jul 8, 2020

ngbot Bot modified the milestone: Backlog Jul 8, 2020

googlebot added the cla: yes label Jul 8, 2020

pullapprove Bot requested a review from atscott July 8, 2020 15:57

jbogarthyde changed the title ~~docs: update router api documentation~~ Update Router API documentation Jul 8, 2020

pullapprove Bot requested review from IgorMinar, alxhub, jelbourn and pkozlowski-opensource July 8, 2020 17:29

pullapprove Bot requested review from IgorMinar, alxhub, jelbourn and pkozlowski-opensource July 14, 2020 20:54

atscott approved these changes Jul 14, 2020

View reviewed changes

Comment thread packages/router/src/router_module.ts Outdated

Comment thread packages/router/src/router_module.ts Outdated

jbogarthyde force-pushed the jb-apidoc-router branch 2 times, most recently from c43ff61 to 7ee48c6 Compare July 15, 2020 14:45

jbogarthyde added the action: review The PR is still awaiting reviews from at least one requested reviewer label Jul 15, 2020

jelbourn approved these changes Jul 15, 2020

View reviewed changes

jbogarthyde added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Jul 16, 2020

jbogarthyde force-pushed the jb-apidoc-router branch from 3efead9 to 7906e0f Compare July 16, 2020 15:37

docs: update router api documentation

ce88f29

Edit descriptions, usage examples, and add links to be complete and consistent with API reference doc style

jbogarthyde force-pushed the jb-apidoc-router branch from 7906e0f to ce88f29 Compare July 16, 2020 15:38

atscott mentioned this pull request Jul 16, 2020

feat(router): add new initialNavigation options to replace legacy #37480

Closed

14 tasks

AndrewKushnir removed request for IgorMinar, alxhub and pkozlowski-opensource July 16, 2020 19:37

AndrewKushnir pushed a commit that referenced this pull request Jul 16, 2020

docs: update router api documentation (#37980)

99960a9

Edit descriptions, usage examples, and add links to be complete and consistent with API reference doc style PR Close #37980

AndrewKushnir closed this in 6c9401c Jul 16, 2020

jbogarthyde deleted the jb-apidoc-router branch July 20, 2020 15:29

angular-automatic-lock-bot Bot locked and limited conversation to collaborators Aug 20, 2020

profanis pushed a commit to profanis/angular that referenced this pull request Sep 5, 2020

docs: update router api documentation (angular#37980)

c73e275

Edit descriptions, usage examples, and add links to be complete and consistent with API reference doc style PR Close angular#37980

Conversation

jbogarthyde commented Jul 8, 2020

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 8, 2020

Uh oh!

mary-poppins commented Jul 8, 2020

Uh oh!

mary-poppins commented Jul 8, 2020

Uh oh!

mary-poppins commented Jul 8, 2020

Uh oh!

mary-poppins commented Jul 8, 2020

Uh oh!

mary-poppins commented Jul 8, 2020

Uh oh!

mary-poppins commented Jul 8, 2020

Uh oh!

mary-poppins commented Jul 8, 2020

Uh oh!

jelbourn commented Jul 14, 2020

Uh oh!

petebacondarwin commented Jul 14, 2020

Uh oh!

Uh oh!

Uh oh!

mary-poppins commented Jul 15, 2020

Uh oh!

mary-poppins commented Jul 15, 2020

Uh oh!

jelbourn left a comment

Choose a reason for hiding this comment

Uh oh!

ngbot Bot commented Jul 16, 2020

Uh oh!

mary-poppins commented Jul 16, 2020

Uh oh!

angular-automatic-lock-bot Bot commented Aug 20, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants