Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds naming conventions documentation #223

Merged
merged 4 commits into from
Oct 10, 2013
Merged

Adds naming conventions documentation #223

merged 4 commits into from
Oct 10, 2013

Conversation

alvincrespo
Copy link
Contributor

Creates initial documentation for naming conventions.

{% endraw %}
{% endhighlight %}

This is great. However, in Ember App Kit we use a Resolver to alleviate the issue of namespacing your views, controllers, models, etc... So the above example would not work.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May I suggest a slight change in copy? "Ember App Kit uses a Resolver to alleviate the issue of namespacing your objects (views, controllers, etc.). The above example, as such, will not work."

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is a "Resolver"

@stefanpenner
Copy link
Owner

looks good, you may want to add nested directories.

controller/posts/new.js -> controller:posts/new
controller/posts/comment_thread.js -> controller:posts/comment-thread

additionally, showing how these work in "needs", with the view helper etc.etc.


{% highlight sh %}
{% raw %}
{{view 'userview'}}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was having trouble with this naming convention when I stumbled upon this pull request. It seems like it should be {{view 'user'}}, as what you have here didn't work for me.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@paperbakwriter09 +1 good catch. Additionally

{{view 'user/show'}} should be possible for "sub-dirs"

@alvincrespo
Copy link
Contributor Author

Sweet. Ill take care of these.

@alvincrespo
Copy link
Contributor Author

Ok cool. Above commit handles the comments from the past commit. Let me know if there are any other changes - seems to be good for now :)


### Views and Templates

Lets say we were using Ember out of the box with the following view:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh! Minor typo: "Let's", not "Lets".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@alvincrespo
Copy link
Contributor Author

@jherdman and @stefanpenner Updated the docs. Sorry for the delay. Loving the feedback! Let me know if this looks good :)

stefanpenner added a commit that referenced this pull request Oct 10, 2013
Adds naming conventions documentation
@stefanpenner stefanpenner merged commit 25c22f6 into stefanpenner:gh-pages Oct 10, 2013
@alvincrespo
Copy link
Contributor Author

w00t!

@stefanpenner
Copy link
Owner

thanks bro! goes back to sleep

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants