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

deno doc --lint doesn't recognise JSDoc description if preceded by @deprecation #420

Open
iuioiua opened this issue Dec 11, 2023 · 1 comment
Labels
bug Something isn't working

Comments

@iuioiua
Copy link
Contributor

iuioiua commented Dec 11, 2023

To reproduce:

  1. Run deno doc --lint https://deno.land/[email protected]/encoding/hex.ts.
  2. Observe that the linter claims that the encode() function is missing a JSDoc comment.

The function isn't missing a JSDoc comment. Rather, the JSDoc comment isn't being recognised because a @deprecated block comes before the comment. The workaround is to move the comment to be the first block.

@crowlKats
Copy link
Member

Yes, this goes for most if not all jsdoc tags: they are greedy and as such the description/body needs to always come before any tag.

@dsherret dsherret added the bug Something isn't working label Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants