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

docs(uuid): update module docs #4790

Merged
merged 16 commits into from
May 29, 2024
Merged

docs(uuid): update module docs #4790

merged 16 commits into from
May 29, 2024

Conversation

marvinhagemeister
Copy link
Contributor

  • Some wording changes
  • Show an example of how to use this module on the main page on jsr.io

@marvinhagemeister marvinhagemeister requested a review from kt3k as a code owner May 21, 2024 07:41
@github-actions github-actions bot added the uuid label May 21, 2024
Copy link

codecov bot commented May 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.36%. Comparing base (ab6d747) to head (0e86222).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4790   +/-   ##
=======================================
  Coverage   92.35%   92.36%           
=======================================
  Files         488      488           
  Lines       41581    41604   +23     
  Branches     5405     5405           
=======================================
+ Hits        38403    38426   +23     
  Misses       3122     3122           
  Partials       56       56           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@iuioiua iuioiua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PTAL at https://github.com/denoland/deno_std/blob/main/.github/CONTRIBUTING.md#documentation

It contains steps such as adding uuid/mod.ts to the lint:docs task.

uuid/mod.ts Outdated Show resolved Hide resolved
uuid/mod.ts Outdated Show resolved Hide resolved
marvinhagemeister and others added 2 commits May 21, 2024 10:11
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
@crowlKats
Copy link
Member

crowlKats commented May 21, 2024

Some of the functions in this module are missing @param and @return doc tags

@kt3k kt3k mentioned this pull request May 23, 2024
38 tasks
@iuioiua iuioiua marked this pull request as draft May 28, 2024 11:17
"../uuid/v1.ts",
"../uuid/v3.ts",
"../uuid/v4.ts",
"../uuid/v5.ts",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Files are done individually because deno doc --lint uuid/mod.ts doesn't work.

uuid/mod.ts Outdated Show resolved Hide resolved
@iuioiua iuioiua marked this pull request as ready for review May 29, 2024 04:34
Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@iuioiua iuioiua merged commit 999e5e7 into main May 29, 2024
12 checks passed
@iuioiua iuioiua deleted the uuid-docs branch May 29, 2024 05:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants