Directives link API documentation did not describe or mention the controller param. #13028

hahla · 2015-10-06T22:29:41Z

The 4th param for link() was not defined in the api doc, but used in the examples. This change adds the param and describes it.

gkalpak · 2015-10-07T06:40:37Z

It is not that simple 😄

Basically, there is a fifth parameter (transcludeFn) and the controller(s) paremeter value depends on several factors. I suggest you briefly mention the 5 parameters and link to $compile API docs for more info.

@hahla, could you make that change ?

hahla · 2015-10-07T06:45:04Z

Yes sounds good, will update
On Tue, Oct 6, 2015 at 11:43 PM Georgios Kalpakas [email protected]
wrote:

It is not that simple [image: 😄]

Basically, there is a fifth parameter (transcludeFn) and the controller(s)
paremeter value depends on several factors. I suggest you briefly mention
the 5 parameters and link to $compile API docs
https://docs.angularjs.org/api/ng/service/%24compile#-link- for more
info.

@hahla https://github.com/hahla, could you make that change ?

—
Reply to this email directly or view it on GitHub
#13028 (comment).

Sent from my iPhone

gkalpak · 2015-10-07T07:09:01Z

Fantastic !
_{Feel free to ping me when you're done, so I can take another look.}

Adds reference to $compile for link function parameters and gives quick intro to 5th param transcludeFn which was also missing in doc.

hahla · 2015-10-07T22:54:15Z

@gkalpak updated and ready for your review

gkalpak · 2015-10-08T08:32:18Z

docs/content/guide/directive.ngdoc


 * `scope` is an Angular scope object.
 * `element` is the jqLite-wrapped element that this directive matches.
 * `attrs` is a hash object with key-value pairs of normalized attribute names and their
  corresponding attribute values.
+* `controller` is the controller for the directive, if defined.
+* `transcludeFn` is a transclude linking function pre-bound to the correct translusion scope.


translusion --> transclusion

gkalpak · 2015-10-08T08:41:23Z

@hahla, thx ! I left a couple of comments.
I wonder if can link directly to https://docs.angularjs.org/api/ng/service/$compile#-link-.

LGTM with the comments addressed.

Updates high level overview for directive link function based on PR comments

hahla · 2015-10-10T20:32:08Z

@gkalpak few comments:

I tried to link (no pun intended ;)) to the $compile.link function, but was unable to. Then I read more closely your comment "..$compile#-link-..." and got it working. Great!
I did another round of edits to improve readability in the context of the article example ("build a directive to display the current time"), while giving the key information on the link function. I decided to not copy the full description of the controller parameter because it was going to be a bit too detailed at this point in the docs and would be distracting to have sub-bullets.
added an alert-info to the page which gives a clear link for more detail on the $compile API.

Anyway let me know what you think.

hahla · 2015-10-14T00:22:12Z

@gkalpak Looks like there was a CI error with the protractor execution, but I don't see any code errors on my side? How do we get Travis CI to re-run the tests, or should I send in a no-op commit to re-trigger the CI test?

gkalpak · 2015-10-14T06:47:17Z

LGTM. I restarted the job (it was indeed a flake).
I'll merge if Travis is happy.

Thx @hahla for working on this 👍

The `controller` and `transclude` parameters of the linking function were not mentioned in the description, but used in the examples. This commit improves the description and links to the `$compile` API docs for more details. Closes #13028

gkalpak · 2015-10-14T07:54:35Z

Backported to v1.4.x as 8a944b0.

docs(guide/Directives): describe your change...

e6e8811

The 4th param for link() was not defined in the api doc, but used in the examples. This change adds the param and describes it.

googlebot added the cla: yes label Oct 6, 2015

Narretz self-assigned this Oct 6, 2015

Narretz added the type: docs label Oct 6, 2015

Narretz added this to the Backlog milestone Oct 6, 2015

Narretz removed their assignment Oct 7, 2015

docs(guide/Directives):

33d8a27

Adds reference to $compile for link function parameters and gives quick intro to 5th param transcludeFn which was also missing in doc.

gkalpak reviewed Oct 8, 2015
View reviewed changes

docs(guide/Directives):

b950c75

Updates high level overview for directive link function based on PR comments

docs(guide/Directives): link direct to $compile#-link-

7eecf1a

gkalpak closed this in 914a934 Oct 14, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Directives link API documentation did not describe or mention the controller param. #13028

Directives link API documentation did not describe or mention the controller param. #13028

hahla commented Oct 6, 2015

gkalpak commented Oct 7, 2015

hahla commented Oct 7, 2015

gkalpak commented Oct 7, 2015

hahla commented Oct 7, 2015

gkalpak Oct 8, 2015

gkalpak commented Oct 8, 2015

hahla commented Oct 10, 2015

hahla commented Oct 14, 2015

gkalpak commented Oct 14, 2015

gkalpak commented Oct 14, 2015

Directives link API documentation did not describe or mention the controller param. #13028

Directives link API documentation did not describe or mention the controller param. #13028

Conversation

hahla commented Oct 6, 2015

gkalpak commented Oct 7, 2015

hahla commented Oct 7, 2015

gkalpak commented Oct 7, 2015

hahla commented Oct 7, 2015

gkalpak Oct 8, 2015

Choose a reason for hiding this comment

gkalpak commented Oct 8, 2015

hahla commented Oct 10, 2015

hahla commented Oct 14, 2015

gkalpak commented Oct 14, 2015

gkalpak commented Oct 14, 2015