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.

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

Add missing doc comments for more types #208

Merged
merged 1 commit into from
Aug 17, 2022
Merged

Conversation

MaxDesiatov
Copy link
Contributor

I noticed that some of our types had no doc comments or had inconsistent formatting, here's a (potentially incomplete) fix for that.

@MaxDesiatov MaxDesiatov added the documentation Improvements or additions to documentation label Aug 17, 2022
@MaxDesiatov MaxDesiatov requested a review from a team August 17, 2022 17:31
@MaxDesiatov MaxDesiatov marked this pull request as ready for review August 17, 2022 17:31
@github-actions
Copy link

Time Change: +235ms (1%)

Total Time: 22,373ms

Test name Duration Change
Serialization/Call JavaScript function directly 4ms +2ms (40%) 🚨
Serialization/Assign JavaScript number directly 4ms -1ms 🎉
Serialization/Call with JavaScript number directly 5ms +1ms (24%) 🚨
Serialization/Write JavaScript string directly 6ms +2ms (39%) 🚨
Serialization/Call with JavaScript string directly 4ms +1ms (37%) 🚨
View Unchanged
Test name Duration Change
Serialization/JavaScript function call through Wasm import 24ms +0ms
Serialization/JavaScript function call through Wasm import with int 20ms +0ms
Serialization/JavaScript function call from Swift 665ms +17ms (2%)
Serialization/Swift Int to JavaScript with assignment 429ms +3ms (0%)
Serialization/Swift Int to JavaScript with call 2,601ms +1ms (0%)
Serialization/JavaScript Number to Swift Int 678ms -7ms (1%)
Serialization/Swift String to JavaScript with assignment 491ms +4ms (0%)
Serialization/Swift String to JavaScript with call 2,780ms +7ms (0%)
Serialization/JavaScript String to Swift String 6,399ms +29ms (0%)
Object heap/Increment and decrement RC 8,263ms +174ms (2%)

@MaxDesiatov MaxDesiatov merged commit 6e62619 into main Aug 17, 2022
@MaxDesiatov MaxDesiatov deleted the maxd/update-docs branch August 17, 2022 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants