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

Error creating comments with eslint rules #75

Open
jomarquez21 opened this issue Oct 3, 2021 · 1 comment
Open

Error creating comments with eslint rules #75

jomarquez21 opened this issue Oct 3, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@jomarquez21
Copy link

jomarquez21 commented Oct 3, 2021

This error is because the comment starts with /**, if you used /* instead, eslint does not log this as an error.

Captura de Pantalla 2021-10-03 a la(s) 14 58 12

I'm not sure if this is an error from my API documentation, or if the error is because a * is being added in the following line

@phryneas
Copy link
Collaborator

phryneas commented Oct 3, 2021

If we were not adding a /** that comment would not show up in autocomplete popups for these parameters in your IDE - which is usually desirable.
We should probably add an option to add an /* eslint-disable */ comment at the top of generated api files.

@phryneas phryneas added the enhancement New feature or request label Nov 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants