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

Master #2270

Closed
wants to merge 31 commits into from
Closed

Master #2270

wants to merge 31 commits into from

Conversation

mboles
Copy link
Contributor

@mboles mboles commented Jun 17, 2015

Added JSDoc comments to files at the root of the src/js directory

@heff
Copy link
Member

heff commented Jul 1, 2015

Wow, this looks like a ton of work. Thanks Matt!

@@ -1,3 +1,6 @@
/**
* @file Needed for full path retrieval
Copy link
Member

Choose a reason for hiding this comment

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

Saying this each time isn't ideal. Can you explain why it's needed, and should we try to put real file descriptions for each of these? It could be event as generic as the file name.

@heff
Copy link
Member

heff commented Jul 8, 2015

I noticed that all the jsdoc comments are now all formatted with no space infront of the asterisks after the first line.

/**
*
*/

We really want them to be standard jsdoc tags, which do have a space.

/**
 *
 */

Would you be able to make that update? Otherwise this looks good to merge in.

@heff heff closed this in 77a96be Jul 9, 2015
@heff
Copy link
Member

heff commented Jul 9, 2015

Merged in. Thanks @mboles!

import Button from './button.js';
import Component from './component.js';

/* Big Play Button
================================================================================ */
/ * Big Play Button
Copy link
Member

Choose a reason for hiding this comment

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

@mboles FYI, the find replace wasn't 100% safe. It added a comment-breaking space in a few places like this. I cleaned them up, but just a heads up in case you use that again.

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.

2 participants