docs(semver): improve docs #4846
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
magurotuna
reviewed
May 24, 2024
iuioiua
suggested changes
May 26, 2024
semver/range_max.ts
Outdated
| * | ||
| * @example Usage | ||
| * ```ts | ||
| * // This API is deprecated |
There was a problem hiding this comment.
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>
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
part of #3764
This improves the API docs of
@std/semver