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.

Sign up for GitHub

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

Jump to bottom

docs(encoding): polish documentation #4497

Merged
merged 8 commits into from
Apr 2, 2024
Merged

docs(encoding): polish documentation #4497

merged 8 commits into from
Apr 2, 2024

Conversation

iuioiua
Copy link
Collaborator

@iuioiua iuioiua commented Mar 16, 2024

This file allow us to provide module docs and an entrypoint for the off-chance that one does want utilities for multiple formats.

Towards a 100% JSR score.

@iuioiua iuioiua requested a review from kt3k as a code owner March 16, 2024 01:58
@kt3k
Copy link
Member

kt3k commented Mar 16, 2024

Now encode and decode methods exported from @std/encoding is for varint encoding. That feels a bit misleading to me

@iuioiua
Copy link
Collaborator Author

iuioiua commented Mar 18, 2024

This is true. However, this is more a result of encode() and decode() being inconsistent with other public function names within std/encoding. To be consistent, they should instead be encodeVarint() and decodeVarint().

@iuioiua iuioiua changed the title refactor(encoding): mod.ts and module docs docs(encoding): polish documentation Apr 2, 2024
@iuioiua iuioiua marked this pull request as draft April 2, 2024 04:02
@iuioiua iuioiua marked this pull request as ready for review April 2, 2024 05:08
kt3k
kt3k approved these changes Apr 2, 2024
View reviewed changes
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 6a7efa1 into main Apr 2, 2024
11 checks passed
@iuioiua iuioiua deleted the encoding-module-docs branch April 2, 2024 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kt3k kt3k kt3k approved these changes

Assignees
No one assigned
Labels
encoding
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@iuioiua @kt3k