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

Run deno doc --lint on all exported files #3878

Closed
lucacasonato opened this issue Nov 29, 2023 · 2 comments
Closed

Run deno doc --lint on all exported files #3878

lucacasonato opened this issue Nov 29, 2023 · 2 comments
Labels
good first issue Good for newcomers PR welcome A pull request for this issue would be welcome

Comments

@lucacasonato
Copy link
Member

To ensure all files have sufficient documentation, we should run deno doc --lint. This will expose errors such as:

  • missing JSDoc comments on exported symbols
    • Missing JSDoc comment.
          at file:///Users/lucacasonato/projects/github.com/denoland/deno_std/data_structures/binary_search_tree.ts:177:3
      
  • symbols that are part of the public API, but not exposed
    • Type 'BinarySearchTree.prototype.rotateNode' references type 'Direction' which is not exported from a root module.`
      
  • missing explicit typings on arguments / return types
    • Missing return type.
          at file:///Users/lucacasonato/projects/github.com/denoland/deno_std/data_structures/comparators.ts:5:1
      
@iuioiua
Copy link
Contributor

iuioiua commented Nov 29, 2023

Yep, for sure. It might also save a bit of time targeting any mod.ts files.

I think these points are best part of #3764 instead of a separate issue, as they refer to the same task.

@iuioiua iuioiua added help wanted Extra attention is needed good first issue Good for newcomers labels Dec 13, 2023
@iuioiua iuioiua added PR welcome A pull request for this issue would be welcome and removed help wanted Extra attention is needed labels Jan 22, 2024
@iuioiua
Copy link
Contributor

iuioiua commented Apr 12, 2024

I'm closing this in favor of #3878, which requires running deno doc—-lint on exported files.

@iuioiua iuioiua closed this as not planned Won't fix, can't repro, duplicate, stale Apr 12, 2024
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 PR welcome A pull request for this issue would be welcome
Projects
None yet
Development

No branches or pull requests

2 participants