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

docs(guide/Directives): remove confusing definition object message #14871

Closed
wants to merge 1 commit into from

Conversation

jdai8
Copy link
Contributor

@jdai8 jdai8 commented Jul 6, 2016

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Docs update

Please check if the PR fulfills these requirements

Other information:

Prior to this point, the doc does not mention returning a postLink function, and all the examples use the definition object form. New readers could misinterpret "returning a function" as returning the factory function mentioned in the previous section.

Since this page is only a "gentle introduction" to directives, using the definition object is a best practice, and the message is already echoed in the docs for $compile, I think we should just remove the message altogether.

Prior to this point, the doc does not mention returning a postLink function, and all the examples use the definition object form. So, this message is confusing to new readers who may misinterpret "returning a function" as returning the factory function mentioned in the previous section.

Since this page is only a "gentle introduction" to directives, and using the definition object is a best practice, I think we should just remove the message altogether.
@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please let us know the company's name.

1 similar comment
@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please let us know the company's name.

@jdai8
Copy link
Contributor Author

jdai8 commented Jul 6, 2016

I signed it!

@googlebot
Copy link

CLAs look good, thanks!

1 similar comment
@googlebot
Copy link

CLAs look good, thanks!

@googlebot googlebot added cla: yes and removed cla: no labels Jul 6, 2016
@gkalpak gkalpak closed this in c4da2f0 Jul 6, 2016
gkalpak pushed a commit that referenced this pull request Jul 6, 2016
Prior to this point, the docs do not mention returning a postLink function, and all the examples use
the definition object form. So, this message is confusing to new readers who may misinterpret
"returning a function" as returning the factory function mentioned in the previous section.

Since this page is only a "gentle introduction" to directives, and using the definition object is a
best practice, it is best to just remove the message altogether.

Closes #14871
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants