Skip to content

/ deno

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

Jump to bottom

missing JSDoc to exported functions in std #7487

Open
tokiedokie opened this issue Sep 15, 2020 · 6 comments
Open

missing JSDoc to exported functions in std #7487

tokiedokie opened this issue Sep 15, 2020 · 6 comments
Labels
docs good first issue std

Comments

@tokiedokie
Copy link
Contributor

@tokiedokie tokiedokie commented Sep 15, 2020 •
edited

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

  • encoding/hex.ts
  • encoding/toml.ts
  • fmt/colors.ts
  • fmt/printf.ts
  • fs/walk.ts
  • http/file_server.ts
  • io/streams.ts
  • io/util.ts
  • log/mod.ts
  • node/querystring.ts
  • node/url.ts
  • node/util.ts
  • path/posix.ts
  • path/win32.ts
  • testing/assert.ts
  • testing/diff.ts
  • uuid/mod.ts
  • uuid/v1.ts
  • uuid/v4.ts
  • uuid/v5.ts
  • ws/mod.ts
@fuku710
Copy link

@fuku710 fuku710 commented Sep 18, 2020

I want to challenge this issue.
aakhtar3 added a commit to aakhtar3/deno that referenced this issue Sep 28, 2020
@aakhtar3
docs(std/uuid): Added JSdocs for the module - denoland#7487
5005193
@aakhtar3 aakhtar3 mentioned this issue Sep 28, 2020
Merged
aakhtar3 added a commit to aakhtar3/deno that referenced this issue Sep 28, 2020
@aakhtar3
docs(std/uuid): Added JSdocs for the std/uuid module - denoland#7487
fe6874b
@fuku710 fuku710 mentioned this issue Sep 30, 2020
Open
@bhumijgupta
Copy link
Contributor

@bhumijgupta bhumijgupta commented Oct 1, 2020

I'd like to add JSDoc docstrings for node/url.ts
@starkensin
Copy link

@starkensin starkensin commented Oct 3, 2020

I will take node/util.ts
@bhumijgupta bhumijgupta mentioned this issue Oct 3, 2020
Open
starkensin added a commit to starkensin/deno that referenced this issue Oct 3, 2020
@starkensin
docs: add JSdoc for std/node/util.ts (denoland#7487)
a096f53
@starkensin starkensin mentioned this issue Oct 3, 2020
Open
@crowlKats
Copy link
Contributor

@crowlKats crowlKats commented Oct 3, 2020

this is a dream issue for people who just want to complete hacktoberfest...
@bhumijgupta
Copy link
Contributor

@bhumijgupta bhumijgupta commented Oct 3, 2020

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
@AtakanErmis AtakanErmis mentioned this issue Oct 3, 2020
Merged
starkensin added a commit to starkensin/deno that referenced this issue Oct 3, 2020
@starkensin @hanseo-addd
docs: add JSdoc for std/node/util.ts (denoland#7487)
db5504f
starkensin added a commit to starkensin/deno that referenced this issue Oct 3, 2020
@starkensin
docs: add JSdoc for std/node/util.ts (denoland#7487)
899ec0e
@DCtheTall
Copy link

@DCtheTall DCtheTall commented Oct 5, 2020

I'd also be interested in participating in this for a Hacktoberfest PR if the owners of this repo are willing 😄
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs good first issue std
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
7 participants
@lucacasonato @crowlKats @fuku710 @DCtheTall @bhumijgupta @starkensin @tokiedokie
You can’t perform that action at this time.