Skip to content

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

Closed as not planned
Closed as not planned

Description

@lucacasonato

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
      

Activity

  1. iuioiua commented on Nov 29, 2023

    @iuioiua
    Contributor

    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.

  2. added
    PR welcomeA pull request for this issue would be welcome
    and removed
    help wantedExtra attention is needed
    on Jan 22, 2024
  3. iuioiua commented on Apr 12, 2024

    @iuioiua
    Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    PR welcomeA pull request for this issue would be welcomegood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions