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

Descriptions when using the @readonly JSDoc tag #266

Open
2 tasks done
break-stuff opened this issue Jul 5, 2024 · 1 comment
Open
2 tasks done

Descriptions when using the @readonly JSDoc tag #266

break-stuff opened this issue Jul 5, 2024 · 1 comment

Comments

@break-stuff
Copy link
Collaborator

Checklist

  • Did you run the analyzer with the --dev flag to get more information?
  • Did you create a minimal reproduction in the playground?

Completing the items above will greatly improve triaging time of your issue.

The order of the @readonly jsDoc tag determines if the description is captured.

This does not work:

/** @readonly My description */

Neither does this:

/** 
  * @readonly 
  * My description 
  */

But this does work:

/** 
  * My description 
  * @readonly 
  */

Expected behavior
A clear and concise description of what you expected to happen.

I would expect the description to be captured in each of these scenarios.

@thepassle
Copy link
Member

Can you create a PR? 🙂

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

No branches or pull requests

2 participants