Repository navigation
Convert JSDoc comments to line comments for internal APIs - #298
Open
bartveneman wants to merge 1 commit into
Open
bartveneman wants to merge 1 commit into
bartveneman wants to merge 1 commit into
Conversation
Comments on symbols that never appear in the generated .d.ts no longer end up in dist.
Contributor
🎉 Package Size Decrease
|
Member
Author
|
The "Audit packages" check fails with 7 advisories in dev dependencies (e.g. Generated by Claude Code |
commit: |
This file contains hidden or 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
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.
Summary
This PR converts JSDoc-style block comments (
/** ... */) to standard line comments (// ...) throughout the codebase, particularly for internal APIs and implementation details. This change simplifies the comment style while maintaining documentation clarity.Key Changes
@internalJSDoc tag from class declaration and converted multi-line JSDoc comments to line comments forparse_if_function_node(),parse_if_condition(),parse_if_condition_function(), andparse_value_nodes_in_range()methods@internalJSDoc tag from class declaration and converted multi-line JSDoc comments to line comments forparse_media_feature_content(),parse_supports_declaration_content(), andparse_supports_condition()methodsis_whitespace(),is_digit(),str_equals_range(), andstrip_vendor_prefix()functions; removed@internaltags@internalJSDoc tags and converted multi-line JSDoc comments to line comments forskip_whitespace_forward(),skip_whitespace_and_comments_forward(),skip_whitespace_and_comments_backward(),trim_boundaries(), andfind_colon_at_depth_zero()functions__get_arena(),__get_source(), and__get_index()methods; removed@internaltagsImplementation Details
@internalJSDoc tags have been removed as they are no longer needed with the simplified comment stylehttps://claude.ai/code/session_012iwxGPpt9H7E31PUoDjMXc