Use jsDoc style for block comments #1169

Merged
merged 1 commit into from Oct 23, 2013

Conversation

Projects
None yet
3 participants
@ameyms

ameyms commented Oct 22, 2013

A new PR on 0.9-work in place of previous #1166.
Block comments especially ones with @param and @constructor should ideally follow jsDoc style ie, /** ... */

@nschonni

This comment has been minimized.

Show comment Hide comment
@nschonni

nschonni Oct 22, 2013

Member

@dnschnur I can take a look at adding https://npmjs.org/package/grunt-jsdoc after this lands 😉

Member

nschonni commented Oct 22, 2013

@dnschnur I can take a look at adding https://npmjs.org/package/grunt-jsdoc after this lands 😉

@ameyms

This comment has been minimized.

Show comment Hide comment
@ameyms

ameyms Oct 22, 2013

@nschonni 👍

ameyms commented Oct 22, 2013

@nschonni 👍

@dnschnur

This comment has been minimized.

Show comment Hide comment
@dnschnur

dnschnur Oct 23, 2013

Owner

Looks good; thank you! I'll also update CONTRIBUTING to clarify the use of jsDoc style.

@nschonni That sounds great!

Owner

dnschnur commented Oct 23, 2013

Looks good; thank you! I'll also update CONTRIBUTING to clarify the use of jsDoc style.

@nschonni That sounds great!

@dnschnur dnschnur merged commit 61fb96d into flot:0.9-work Oct 23, 2013

1 check passed

default The Travis CI build passed
Details
@ameyms

This comment has been minimized.

Show comment Hide comment
@ameyms

ameyms Oct 24, 2013

Thanks for merging.
Ill update the CONTRIBUTING.md tonight and maybe even check if there are other files where jsDoc needs to be used.

ameyms commented Oct 24, 2013

Thanks for merging.
Ill update the CONTRIBUTING.md tonight and maybe even check if there are other files where jsDoc needs to be used.

@ameyms

This comment has been minimized.

Show comment Hide comment
@ameyms

ameyms Oct 24, 2013

@dnschnur Also, I filed an 'issue' #1171 because I didn't know how else to request you - but could you please set the default branch for the repo to 0.9-work ?
It will be really useful while raising PRs and browsing the source code via the GitHub website.
Thanks again!

ameyms commented Oct 24, 2013

@dnschnur Also, I filed an 'issue' #1171 because I didn't know how else to request you - but could you please set the default branch for the repo to 0.9-work ?
It will be really useful while raising PRs and browsing the source code via the GitHub website.
Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment