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(semver): improve docs #4846

Merged
merged 10 commits into from
May 27, 2024
Merged

docs(semver): improve docs #4846

merged 10 commits into from
May 27, 2024

Conversation

kt3k
Copy link
Member

@kt3k kt3k commented May 23, 2024

part of #3764

This improves the API docs of @std/semver

@kt3k kt3k mentioned this pull request May 23, 2024
38 tasks
Copy link

codecov bot commented May 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.35%. Comparing base (b9dbcb7) to head (1501f17).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4846      +/-   ##
==========================================
- Coverage   92.35%   92.35%   -0.01%     
==========================================
  Files         487      487              
  Lines       41531    41539       +8     
  Branches     5405     5405              
==========================================
+ Hits        38358    38364       +6     
- Misses       3117     3119       +2     
  Partials       56       56              

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

@iuioiua iuioiua requested a review from magurotuna May 23, 2024 22:22
semver/can_parse.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@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.

Great to have this done! My main nit is the proper casing of "SemVer".

semver/can_parse.ts Outdated Show resolved Hide resolved
semver/greater_than_range.ts Outdated Show resolved Hide resolved
semver/can_parse.ts Outdated Show resolved Hide resolved
semver/equals.ts Outdated Show resolved Hide resolved
semver/format.ts Outdated Show resolved Hide resolved
semver/mod.ts Outdated Show resolved Hide resolved
*
* @example Usage
* ```ts
* // This API is deprecated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps, we can have two snippets in this example; one for the deprecated usage and one for the new API's usage, like a migration guide.

Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
Copy link
Collaborator

@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.

Nice!

@kt3k kt3k merged commit 083b63f into denoland:main May 27, 2024
12 checks passed
@kt3k kt3k deleted the document-semver branch May 27, 2024 10:03
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