Skip to content

enhance: Improve TSDoc comments#4203

Merged
huozhi merged 2 commits intomainfrom
shu/RHq88
Dec 15, 2025
Merged

enhance: Improve TSDoc comments#4203
huozhi merged 2 commits intomainfrom
shu/RHq88

Conversation

@shuding
Copy link
Copy Markdown
Member

@shuding shuding commented Dec 15, 2025

Currently there's no good TSDoc comments for overloaded methods:

CleanShot 2025-12-15 at 14 18 51@2x

With this change, there will be more verbose examples and explanation on every case:

CleanShot 2025-12-15 at 14 15 49

Also includes some other descriptions and adjustments with the help of Claude.

@shuding shuding requested a review from huozhi as a code owner December 15, 2025 13:21
@codesandbox-ci
Copy link
Copy Markdown

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@huozhi huozhi changed the title chore: Improve TSDoc comments enhance: Improve TSDoc comments Dec 15, 2025
@huozhi huozhi merged commit eff8fda into main Dec 15, 2025
6 checks passed
@huozhi huozhi deleted the shu/RHq88 branch December 15, 2025 16:27
dcondrey pushed a commit to dcondrey/swr that referenced this pull request Dec 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants