docs(encoding): Cleanup and fix doc lints #4838
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 #4838 +/- ##
==========================================
- Coverage 91.97% 91.97% -0.01%
==========================================
Files 487 487
Lines 41539 41545 +6
Branches 5365 5365
==========================================
+ Hits 38207 38211 +4
- Misses 3274 3276 +2
Partials 58 58 ☔ View full report in Codecov by Sentry. |
kt3k
reviewed
May 23, 2024
| @@ -2,16 +2,24 @@ | |||
| // Copyright 2020 Keith Cirkel. All rights reserved. MIT license. | |||
| // Copyright 2023 Skye "MierenManz". All rights reserved. MIT license. | |||
| /** | |||
| * Functions for encoding typed integers in array buffers. | |||
| * Utilities for {@link https://protobuf.dev/programming-guides/encoding/#varints VarInt} encoding | |||
kt3k
reviewed
May 23, 2024
| @@ -20,8 +28,19 @@ | |||
| // This implementation is a port of https://deno.land/x/varint@v2.0.0 by @keithamus | |||
| // This module is browser compatible. | |||
|
|
|||
| /** | |||
| * The maximum value of an unsigned 64-bit integer. | |||
| * Equivalent to `2n**64n - 1n` | |||
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.
Fixes doc lints for the
encodingpackage to prepare for stabilization.While I was there, I also updated examples to use assertions (and caught a couple of incorrect examples in the process).