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.

Sign up for GitHub

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

Jump to bottom

Refactor DocBlocks #130

Open
notmessenger opened this issue Apr 21, 2015 · 0 comments
Open

Refactor DocBlocks #130

notmessenger opened this issue Apr 21, 2015 · 0 comments
Labels
1 - Ready documentation

Comments

@notmessenger
Copy link
Collaborator

  • use @returns over @return
  • use @return {undefined} when function does not return anything
  • param types should be their most generic form - Array vs Ember.Array, Object vs Ember.Object - except for cases in which a more specific Ember.* type is warranted.
  • types should be capitalized - Number, Boolean, Object, Function - all except for "undefined" which should be all lowercase.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
1 - Ready documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@notmessenger