[FCE-1046] Update comments for better docs #248
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
mironiasty
changed the title
mironiasty
requested review from
czerwiukk and
MiloszFilimowski
and removed request for
czerwiukk
czerwiukk
approved these changes
Jan 21, 2025
| @@ -13,7 +13,7 @@ type Props = { | |||
|
|
|||
| export function Tile({ videoTrack, audioTrack, name, id }: Props) { | |||
| const isMuted = !audioTrack || audioTrack.metadata?.paused; | |||
| const isSpeaking = useVAD([id])[id]; | |||
There was a problem hiding this comment.
btw: do you think useVAD({ peerIds: [id] }) would make the api easier to comprehend?
There was a problem hiding this comment.
Yeah, makes sense. I updated method definition
Co-authored-by: Adrian Czerwiec <[email protected]>
mironiasty
force-pushed
the
update-doc-comments
branch
from
daff1e2 to
759c282
Compare
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.
Description
Remove explicit return types for hooks, and instead use implicit types. This will make documentation more readable. So instead of this, we could have something like this.
Motivation and Context
Make documentation better.
Types of changes
not work as expected)