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

Update controller.ngdoc #8011

Closed
wants to merge 2 commits into from
Closed

Conversation

cranesandcaff
Copy link
Contributor

If it is not recommended to use a constructor function to create controllers, why should it be shown as possible in the documentation?

One of the most common complaints about AngularJS is that it doesn't enforce any variety of convention, this is intentional and I generally like this however if we can avoid outright bad implementations or examples I believe we should.

The only real reason to avoid doing so is to avoid introducing the potential new user to a somewhat complex new concept, however it is better to introduce new users to best practices instead of overly simplified examples.

If it is not recommended to use a constructor function to create controllers, why should it be shown as possible in the documentation? 

One of the most common complaints about AngularJS is that it doesn't enforce any variety of convention, this is intentional and I generally like this however if we can avoid outright bad implementations or examples I believe we should.
@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 (#8011)

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!

@cranesandcaff
Copy link
Contributor Author

In response to the automated message, I read through the contributing guidelines, this is a small change to the docs that was initiated from the 'Improve These Docs' button, if there are changes I need to make I will gladly make them, including using the proper format. I believe the contributing docs state that small doc changes don't require that format though.

For some reason changes weren't saved.
@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.

@cranesandcaff
Copy link
Contributor Author

I signed the CLA just now. I'll check in soon to see that you received it.

@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).

@rodyhaddad rodyhaddad modified the milestone: Backlog Jun 29, 2014
@rodyhaddad
Copy link
Contributor

+1

cc @btford

@btford btford self-assigned this Jun 29, 2014
petebacondarwin pushed a commit that referenced this pull request Jul 3, 2014
If it is not recommended to use a global function to create controllers,
why should it be shown as possible in the documentation?

One of the most common complaints about AngularJS is that it doesn't enforce
any convention. This is intentional and I generally like this.
However if we can avoid outright bad implementations in examples I believe
we should.

Closes #8011
@petebacondarwin
Copy link
Contributor

Thanks @cranesandcaff. I squashed, updated the commit message to follow our required format and then merged this. I then tweaked it slightly with c0e6527

ckknight pushed a commit to ckknight/angular.js that referenced this pull request Jul 16, 2014
If it is not recommended to use a global function to create controllers,
why should it be shown as possible in the documentation?

One of the most common complaints about AngularJS is that it doesn't enforce
any convention. This is intentional and I generally like this.
However if we can avoid outright bad implementations in examples I believe
we should.

Closes angular#8011
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.

5 participants