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

support single line style for exported comment #7998

Closed
nhooyr opened this issue Jan 29, 2017 · 3 comments · Fixed by #8065 or renovatebot/renovate#111 · May be fixed by iamhunter/teammates#4
Closed

support single line style for exported comment #7998

nhooyr opened this issue Jan 29, 2017 · 3 comments · Fixed by #8065 or renovatebot/renovate#111 · May be fixed by iamhunter/teammates#4
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation enhancement This change enhances an existing feature of ESLint good first issue Good for people who haven't worked on ESLint before help wanted The team would welcome a contribution from the community for this issue

Comments

@nhooyr
Copy link

nhooyr commented Jan 29, 2017

What version are you using?
v3.14.1

What did you do?
Had an error for no-unused-vars, but my function was intended to be called by the browser. So I looked at the docs and found http://eslint.org/docs/rules/no-unused-vars#exported

So I added a comment like // exported variableName

What happened?
It did not fix the error, I had to change the comment to /* exported variableName */

What did you expect to happen?
I find it weird that eslint does not support both comment styles.
@eslintbot eslintbot added the triage An ESLint team member will look at this issue soon label Jan 29, 2017
@ilyavolodin
Copy link
Member

Inline commands were added to support per-line operations. Since adding exported is a global operation, and doesn't target specific line it has to be block-level comment. I think we can updated documentation to make it clear that you have to use block comments.

@ilyavolodin ilyavolodin added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation enhancement This change enhances an existing feature of ESLint and removed triage An ESLint team member will look at this issue soon labels Jan 29, 2017
@kaicataldo kaicataldo added good first issue Good for people who haven't worked on ESLint before help wanted The team would welcome a contribution from the community for this issue labels Feb 6, 2017
@kaicataldo
Copy link
Member

In addition to @ilyavolodin's suggestion, I wonder if we should include a code example for clarity.

@leeyimin
Copy link
Contributor

Hi! I would like to work on this issue. I will try to finish asap.

leeyimin added a commit to leeyimin/eslint that referenced this issue Feb 11, 2017
@leeyimin
Docs: Add code example and info on line comment for /* exported */ (f…
320b550 
…ixes eslint#7998)
leeyimin added a commit to leeyimin/eslint that referenced this issue Feb 11, 2017
@leeyimin
Docs: Add documentation for /* exported */ (fixes eslint#7998)
e5f27a6 
Added information about using line comment and a code example for
correct usage.
@leeyimin leeyimin mentioned this issue Feb 11, 2017
Merged
gyandeeps pushed a commit that referenced this issue Feb 11, 2017
@leeyimin @gyandeeps
Docs: Add documentation for /* exported */ (fixes #7998) (#8065)
6445d2a 
Added information about using line comment and a code example for
correct usage.
This was referenced Feb 20, 2017
Merged
Merged
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation enhancement This change enhances an existing feature of ESLint good first issue Good for people who haven't worked on ESLint before help wanted The team would welcome a contribution from the community for this issue
Projects
None yet
Milestone
No milestone
5 participants
@ilyavolodin @leeyimin @kaicataldo @nhooyr @eslintbot