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

refactor(semver): unify param names #5700

Merged
merged 4 commits into from
Aug 19, 2024
Merged

Conversation

timreichen
Copy link
Contributor

Changes
This PR unifies names of public functions.

  • value if the argument is a string to be parsed
  • version if the argument is a SemVer
  • versionN... if multiple arguments are SemVers
  • Range if the argument is a Range

Reasoning
The docs are automatically created and use the jsdoc param names.
It makes the docs more esthetically pleasing and easier to understand.

@timreichen timreichen requested a review from kt3k as a code owner August 16, 2024 22:41
Copy link

codecov bot commented Aug 18, 2024

Codecov Report

Attention: Patch coverage is 97.97980% with 2 lines in your changes missing coverage. Please review.

Project coverage is 96.25%. Comparing base (1bc290b) to head (d5b637e).
Report is 6 commits behind head on main.

Files Patch % Lines
semver/try_parse_range.ts 0.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5700   +/-   ##
=======================================
  Coverage   96.25%   96.25%           
=======================================
  Files         477      477           
  Lines       38512    38509    -3     
  Branches     5585     5591    +6     
=======================================
- Hits        37070    37068    -2     
+ Misses       1400     1399    -1     
  Partials       42       42           

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

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.

Nice improvement in docs consistency! Thanks!

@kt3k kt3k merged commit f3a22c0 into denoland:main Aug 19, 2024
13 checks passed
@timreichen timreichen deleted the semver-param-names branch August 24, 2024 07:55
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.

2 participants