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

fix: eslint valid jsdoc #203

Merged
merged 3 commits into from
Jan 16, 2019
Merged

fix: eslint valid jsdoc #203

merged 3 commits into from
Jan 16, 2019

Conversation

greg-a-smith
Copy link
Contributor

@greg-a-smith greg-a-smith commented Jan 15, 2019

Enabled the valid-jsdoc eslint rule and fixed lint errors.

#169

@greg-a-smith greg-a-smith requested a review from a team January 15, 2019 03:53
@bcullman
Copy link
Contributor

not sure about this one… we should discuss the merits of JS docs, if there are any.

@greg-a-smith
Copy link
Contributor Author

Discussing the merits is fine with me. I just chose to remove these since these are minimally useful at best and these are the only two files in the repo using JS docs.

@bcullman
Copy link
Contributor

looks like most of the JSDocs lines came from @CodesOfRa, it woul dbe best if she chimes in before removing this.

it does appear that we are manually documenting props in the *.Components.js files. If we were to use these JSDocs capabilities, instead, we should do it universally, and in a way that can be consumed automatically by ghpages.

@CodesOfRa
Copy link
Contributor

@bcullman @greg-a-smith we can remove them 👍

Copy link
Contributor

@bcullman bcullman left a comment

Choose a reason for hiding this comment

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

after resolving conficts, 🚢

@greg-a-smith greg-a-smith merged commit 6268407 into master Jan 16, 2019
@greg-a-smith greg-a-smith deleted the fix/eslint-valid-jsdoc branch January 16, 2019 20:24
greg-a-smith added a commit that referenced this pull request Mar 5, 2019
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.

None yet

3 participants