Deno: missing JSDoc to exported functions in std

Created on 15 Sep 2020  路  13Comments  路  Source: denoland/deno

there are many exported functions in standard library but some functions' JSDocs are missing

here is the list of ts files that need to be updated

  • [x] encoding/hex.ts
  • [x] encoding/toml.ts
  • [x] fmt/colors.ts
  • [x] fmt/printf.ts
  • [ ] fs/walk.ts
  • [ ] http/file_server.ts
  • [x] io/streams.ts
  • [ ] io/util.ts
  • [x] log/mod.ts
  • [ ] node/querystring.ts
  • [x] node/url.ts
  • [ ] node/util.ts
  • [ ] path/posix.ts
  • [ ] path/win32.ts
  • [ ] testing/assert.ts
  • [ ] testing/diff.ts
  • [x] uuid/mod.ts
  • [x] uuid/v1.ts
  • [x] uuid/v4.ts
  • [x] uuid/v5.ts
  • [ ] ws/mod.ts
docs good first issue std

All 13 comments

I want to challenge this issue.

I'd like to add JSDoc docstrings for node/url.ts

I will take node/util.ts

this is a dream issue for people who just want to complete hacktoberfest...

According to the latest change in rule, a hacktoberfest tag should be present on the repo for it to be included in hacktoberfest. Deno does not have any such tag, so the contributions wont be counted towards it

I'd also be interested in participating in this for a Hacktoberfest PR if the owners of this repo are willing 馃槃

I would like to take io/stream.ts

I will take fmt/colors.ts and fmt/printf.ts

I will take path/posix.ts and path/win32.ts next. Thanks

I want to challenge this issue.
Take ws/mod.ts.

I'd like to take fs/walk.ts.

I want to challenge this issue.
Take ws/mod.ts.

I want to konw is 'there are many exported functions in standard library but some functions' JSDocs are missing' mean
the doc which was missing is exist in standard library?
If it's true, anybody can tell me where is it?
I'm newbie and want to do something for deno.
Standard library is 'https://deno.land/[email protected]' ?
But master branch is also 0.78.0 and no exist comments in https://deno.land/[email protected].
Thanks a lot.

I'll take http/file_server.ts

Was this page helpful?
0 / 5 - 0 ratings

Related issues

benjamingr picture benjamingr  路  3Comments

somombo picture somombo  路  3Comments

ry picture ry  路  3Comments

sh7dm picture sh7dm  路  3Comments

metakeule picture metakeule  路  3Comments