Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Updated $interval documentation #7674

Closed
wants to merge 2 commits into from
Closed

Conversation

sharppanda
Copy link

callback function return parameter with iteration count

callback function return parameter with iteration count
@mary-poppins
Copy link

Thanks for the PR! Please check the items below to help us merge this faster. See the contributing docs for more information.

  • Uses the issue template (#7674)

If you need to make changes to your pull request, you can update the commit with git commit --amend.
Then, update the pull request with git push -f.

Thanks again for your help!

@mary-poppins
Copy link

I'm sorry, but I wasn't able to verify your Contributor License Agreement (CLA) signature. CLA signature is required for any code contributions to AngularJS.

Please sign our CLA and ensure that the CLA signature email address and the email address in this PR's commits match.

If you signed the CLA as a corporation, please let us know the company's name.

Thanks a bunch!

PS: If you signed the CLA in the past then most likely the email addresses don't match. Please sign the CLA again or update the email address in the commit of this PR.
PS2: If you are a Googler, please sign the CLA as well to simplify the CLA verification process.

@caitp
Copy link
Contributor

caitp commented Jun 6, 2014

This has two problems with it.

  1. it makes jscs/jshint yell at us

  2. it doesn't actually output any new information in the rendered docs.

Better solution, make a note about the callback function signature in the description of the parameter.

@mary-poppins
Copy link

CLA signature verified! Thank you!

Someone from the team will now triage your PR and it will be processed based on the determined priority (doc updates and fixes with tests are prioritized over other changes).

Text describing the parameter changed. New version is based on the format from documentation of $watch.
@btford btford added this to the Backlog milestone Jun 10, 2014
@btford btford modified the milestones: Purgatory, Backlog Jun 10, 2014
@rodyhaddad
Copy link
Contributor

You updated the docs in the ngMock version of $interval.
The same doc mistake exists in the main $interval implementation.
I believe that's what Cait means with 2)


What's surprising, is that this behavior isn't tested at all, so I wonder if we want it or not.
cc @juliemr

@caitp
Copy link
Contributor

caitp commented Jun 10, 2014

Actually, I didn't look at the mock documentation, so maybe I'm wrong. But it looks like function parameters don't get serialized in any way in the function parameter docs

@caitp
Copy link
Contributor

caitp commented Jun 10, 2014

Okay, it is getting rendered in this case, although it doesn't actually look very good. So that's better than nothing. Ignore criticism 2 and fix the jscs/jshint issues, we can merge this

@sharppanda
Copy link
Author

This is my first try of updating the documentation.
How can I see the results from jscs/jshint?
Where can I see the final documentation with my change?

@gkalpak
Copy link
Member

gkalpak commented May 31, 2016

Closing as this is not in a merge-able sate. Feel free to open a new PR.

BTW, you can see the failures either here or by running the tests locally on your machine (e.g. grunt ci-checks). For more info see there.

@gkalpak gkalpak closed this May 31, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants