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

Score for "Has docs for most symbols" is wrong when an export has overloads #472

Open
lowlighter opened this issue May 2, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@lowlighter
Copy link

If a symbol has overloads, then only the first one count as being documented so it lower the score

I've confirmed this is the case by publishing two releases of a package, one without overloads and one with them, and it changes the score.
image
image

This package has only one export, and with 4 overloads it reports "Currently 25% of symbols are documented.".
100/4 = 25 (this is actually how I discovered the issue)

@lucacasonato lucacasonato added the bug Something isn't working label May 6, 2024
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
Status: Ready
Development

No branches or pull requests

2 participants