Skip to content

suggestion: account for "single-symbol modules" #183

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

Open
iuioiua opened this issue Mar 5, 2024 · 1 comment
Open

suggestion: account for "single-symbol modules" #183

iuioiua opened this issue Mar 5, 2024 · 1 comment
Labels
good first issue Good for newcomers

Comments

@iuioiua
Copy link
Contributor

iuioiua commented Mar 5, 2024

The Standard Library, I'm sure, along with other packages, has many instances of "single-symbol modules". E.g. @std/assert/assert. An author of a single-symbol module would reasonably have function-level JSDocs, instead of module-level JSDocs, as the Standard Library does. This seems to cause a few issues, which I think should be addressed:

  1. A package score point is deducted because no module docs exist. See https://jsr.io/@std/assert/score.
  2. The module page is empty. See https://jsr.io/@std/[email protected]/doc/assert/~.

I tried addressing these issues with JSDocs in denoland/std#4431, but seems to be the wrong approach.

@github-project-automation github-project-automation bot moved this to Needs Triage in JSR Mar 5, 2024
@lucacasonato lucacasonato moved this from Needs Triage to Needs Plan in JSR Mar 5, 2024
@lucacasonato
Copy link
Member

lucacasonato commented May 1, 2025

Let's change this so that modules that export a single symbol that does have documentation can count as having a module level JSDoc. The change should be made in this function: https://github.com/jsr-io/jsr/blob/main/api/src/analysis.rs#L343.

@lucacasonato lucacasonato added the good first issue Good for newcomers label May 1, 2025
@lucacasonato lucacasonato moved this from Needs Plan to Ready in JSR May 1, 2025
@crowlKats crowlKats removed their assignment May 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: Ready
Development

No branches or pull requests

3 participants