deno_std icon indicating copy to clipboard operation
deno_std copied to clipboard

docs(toml): lint `@std/toml` docs

Open littledivy opened this issue 1 year ago • 4 comments
trafficstars

littledivy avatar May 21 '24 12:05 littledivy

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.36%. Comparing base (7717c29) to head (ffb98f9).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4799   +/-   ##
=======================================
  Coverage   92.36%   92.36%           
=======================================
  Files         488      488           
  Lines       41603    41603           
  Branches     5409     5409           
=======================================
  Hits        38425    38425           
  Misses       3122     3122           
  Partials       56       56           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar May 21 '24 12:05 codecov[bot]

The docs for this module are still very lacking. Neither parse nor stringify has an example, and the docs are quite poor in general.

lucacasonato avatar May 21 '24 12:05 lucacasonato

Oh, the lint should probably detect that? I got an error for missing @example in crypto

littledivy avatar May 21 '24 12:05 littledivy

Yes, I agree it should. See comment at the top of _tools/check_docs.ts: // TODO(iuioiua): Add support for classes and methods. :)

lucacasonato avatar May 21 '24 12:05 lucacasonato