docs: edit copy for tick() in testing and api docs #35697

kapunahelewong · 2020-02-26T21:45:33Z

Fixes #35696

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?

Issue Number: #35696

What is the new behavior?

Style/copy edits to recent PR #33838

Does this PR introduce a breaking change?

Yes
No

Other information

mary-poppins · 2020-02-26T21:55:34Z

You can preview 111004d at https://pr35697-111004d.ngbuilds.io/.

aio/content/guide/testing.md

ngbot · 2020-02-27T18:53:15Z

I see that you just added the PR action: merge label, but the following checks are still failing:
     status "ci/angular: size" is failing
     status "ci/circleci: lint" is failing
     status "ci/circleci: test" is failing
     status "ci/circleci: test_aio_local" is failing
     status "ci/circleci: test_ivy_aot" is failing
     status "google3" is pending
     status "pullapprove" is pending
     missing required status "ci/circleci: publish_snapshot"

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.

gkalpak

Nice! I just noticed this yesterday and wanted to open a PR about this. (Glad you beat me to it 😇)

packages/core/testing/src/fake_async.ts

gkalpak · 2020-02-28T15:10:17Z

packages/core/testing/src/fake_async.ts

- * processNewMacroTasksSynchronously, whether to invoke the new macroTasks, by default is
- * false, means the new macroTasks will be invoked
+ * @param millis, the number of milliseconds to advance the virtual timer
+ * @param tickOptions, the options of `tick()`, which has a flag called


Not sure exactly what is wrong (maybe the commas after the param names), but these docs do not seem to be included on the API docs.

Move the param descriptions up before @usageNotes, like this:

@param fn A function that takes two arguments. * *millis* The number of milliseconds to advance the virtual timer. * *tickOptions* The options to pass to the `tick()` function.

Then put the rest of the advice about using the options into the @usageNotes (rephrasing as appropriate and responding to George's notes 😄 )

packages/core/testing/src/fake_async.ts

googlebot · 2020-03-02T19:27:08Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-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 by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

googlebot · 2020-03-02T19:32:36Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

mary-poppins · 2020-03-02T19:42:57Z

You can preview 7eaef73 at https://pr35697-7eaef73.ngbuilds.io/.

mary-poppins · 2021-05-24T21:36:06Z

You can preview 6b36b4f at https://pr35697-6b36b4f.ngbuilds.io/.

petebacondarwin

Just one small suggestion. But otherwise nice tidy up.

petebacondarwin · 2021-05-24T21:54:35Z

packages/core/testing/src/fake_async.ts

+ * Any arguments passed when calling this returned function will be passed through to the `fn`
+ * function in the parameters when it is called.


petebacondarwin · 2021-05-24T21:55:18Z

packages/core/testing/src/fake_async.ts

+ * @param millis The number of milliseconds to advance the virtual timer.
+ * @param tickOptions The options to pass to the `tick()` function.


petebacondarwin · 2021-05-24T22:03:17Z

packages/core/testing/src/fake_async.ts

 *
- * @param maxTurns
- * @returns The simulated time elapsed, in millis.
+ * @param maxTurns A maximum number of turns.


So digging through the code, I think that maxTurns is basically the maximum number of times the scheduler will attempt to clear its queue before it gives up with an error. It's a kind of Time To Live (TTL) number.

Fixes angular#35696

mary-poppins · 2021-05-24T22:25:01Z

You can preview c5b31ca at https://pr35697-c5b31ca.ngbuilds.io/.

Pete and others have already reviewed this. I think we're good! Thanks, George!

ngbot · 2021-05-24T22:48:18Z

I see that you just added the action: merge label, but the following checks are still failing:
     status "ci/circleci: test_win" is failing
     forbidden labels detected: action: cleanup
     status "google3" is pending

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.

ngbot · 2021-05-25T01:51:52Z

I see that you just added the action: merge label, but the following checks are still failing:
status "google3" is failing

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.

Fixes #35696 PR Close #35697

Fixes angular#35696 PR Close angular#35697

angular-automatic-lock-bot · 2021-06-25T16:07:10Z

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

kapunahelewong added type: bug/fix comp: docs effort1: hours target: patch This PR is targeted for the next patch release risk: low labels Feb 26, 2020

kapunahelewong requested review from JiaLiPassion and aikithoughts February 26, 2020 21:45

ngbot bot modified the milestone: Backlog Feb 26, 2020

googlebot added the cla: yes label Feb 26, 2020

aikithoughts reviewed Feb 26, 2020

View reviewed changes

aio/content/guide/testing.md Outdated Show resolved Hide resolved

aio/content/guide/testing.md Outdated Show resolved Hide resolved

aio/content/guide/testing.md Outdated Show resolved Hide resolved

aio/content/guide/testing.md Outdated Show resolved Hide resolved

JiaLiPassion approved these changes Feb 26, 2020

View reviewed changes

mhevery approved these changes Feb 27, 2020

View reviewed changes

mhevery added the action: merge The PR is ready for merge by the caretaker label Feb 27, 2020

gkalpak previously requested changes Feb 28, 2020

View reviewed changes

kapunahelewong removed the action: merge The PR is ready for merge by the caretaker label Mar 2, 2020

kapunahelewong added this to In Progress in docs Mar 2, 2020

googlebot added cla: no and removed cla: yes labels Mar 2, 2020

kapunahelewong force-pushed the tick-copy-edits branch from 8dbc523 to 7eaef73 Compare March 2, 2020 19:32

googlebot added cla: yes and removed cla: no labels Mar 2, 2020

jbogarthyde added the aio: preview label Mar 2, 2020

aikithoughts requested a review from IgorMinar March 2, 2020 20:45

aikithoughts requested review from petebacondarwin and removed request for IgorMinar, kara and alxhub May 24, 2021 21:26

pullapprove bot requested review from alxhub and AndrewKushnir May 24, 2021 21:27

petebacondarwin approved these changes May 24, 2021

View reviewed changes

docs: edit copy for tick() in testing and api docs

c5b31ca

Fixes angular#35696

aikithoughts force-pushed the tick-copy-edits branch from 6b36b4f to c5b31ca Compare May 24, 2021 22:15

AndrewKushnir approved these changes May 24, 2021

View reviewed changes

aikithoughts requested review from gkalpak and removed request for alxhub and gkalpak May 24, 2021 22:47

aikithoughts added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews action: merge The PR is ready for merge by the caretaker labels May 24, 2021

ngbot bot added the action: merge The PR is ready for merge by the caretaker label May 25, 2021

zarend closed this in d7768c6 May 25, 2021

zarend pushed a commit that referenced this pull request May 25, 2021

docs: edit copy for tick() in testing and api docs (#35697)

c01da21

Fixes #35696 PR Close #35697

umairhm pushed a commit to umairhm/angular that referenced this pull request May 28, 2021

docs: edit copy for tick() in testing and api docs (angular#35697)

38b6857

Fixes angular#35696 PR Close angular#35697

iRealNirmal pushed a commit to iRealNirmal/angular that referenced this pull request Jun 4, 2021

docs: edit copy for tick() in testing and api docs (angular#35697)

a5044dc

Fixes angular#35696 PR Close angular#35697

angular-automatic-lock-bot bot locked and limited conversation to collaborators Jun 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: edit copy for tick() in testing and api docs #35697

docs: edit copy for tick() in testing and api docs #35697

kapunahelewong commented Feb 26, 2020

mary-poppins commented Feb 26, 2020

ngbot bot commented Feb 27, 2020

gkalpak left a comment

gkalpak Feb 28, 2020

jbogarthyde Mar 2, 2020 •

edited

googlebot commented Mar 2, 2020

googlebot commented Mar 2, 2020

mary-poppins commented Mar 2, 2020

mary-poppins commented May 24, 2021

petebacondarwin left a comment

petebacondarwin May 24, 2021

petebacondarwin May 24, 2021

petebacondarwin May 24, 2021

mary-poppins commented May 24, 2021

ngbot bot commented May 24, 2021

ngbot bot commented May 25, 2021

angular-automatic-lock-bot bot commented Jun 25, 2021

		* Any arguments passed when calling this returned function will be passed through to the `fn`
		* function in the parameters when it is called.

		* @param millis The number of milliseconds to advance the virtual timer.
		* @param tickOptions The options to pass to the `tick()` function.

docs: edit copy for tick() in testing and api docs #35697

docs: edit copy for tick() in testing and api docs #35697

Conversation

kapunahelewong commented Feb 26, 2020

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

mary-poppins commented Feb 26, 2020

ngbot bot commented Feb 27, 2020

gkalpak left a comment

Choose a reason for hiding this comment

gkalpak Feb 28, 2020

Choose a reason for hiding this comment

jbogarthyde Mar 2, 2020 • edited

Choose a reason for hiding this comment

googlebot commented Mar 2, 2020

googlebot commented Mar 2, 2020

mary-poppins commented Mar 2, 2020

mary-poppins commented May 24, 2021

petebacondarwin left a comment

Choose a reason for hiding this comment

petebacondarwin May 24, 2021

Choose a reason for hiding this comment

petebacondarwin May 24, 2021

Choose a reason for hiding this comment

petebacondarwin May 24, 2021

Choose a reason for hiding this comment

mary-poppins commented May 24, 2021

ngbot bot commented May 24, 2021

ngbot bot commented May 25, 2021

angular-automatic-lock-bot bot commented Jun 25, 2021

jbogarthyde Mar 2, 2020 •

edited