Add script to check that the tsdoc is correct and up-to-date#3644
Merged
BillCarsonFr merged 2 commits intolivekitfrom Jan 5, 2026
Merged
Add script to check that the tsdoc is correct and up-to-date#3644BillCarsonFr merged 2 commits intolivekitfrom
BillCarsonFr merged 2 commits intolivekitfrom
Conversation
Half-Shot
previously requested changes
Dec 30, 2025
Member
Half-Shot
left a comment
Half-Shot
left a comment
There was a problem hiding this comment.
Seems like a good change, modulo script command?
robintown
approved these changes
Jan 5, 2026
Comment on lines
+141
to
+150
| * @param props The properties required to create the local membership. | ||
| * @param props.scope The observable scope to use. | ||
| * @param props.connectionManager The connection manager to get connections from. | ||
| * @param props.createPublisherFactory Factory to create a publisher once we have a connection. | ||
| * @param props.joinMatrixRTC Callback to join the matrix RTC session once we have a transport. | ||
| * @param props.homeserverConnected The homeserver connected state. | ||
| * @param props.localTransport$ The local transport to use for publishing. | ||
| * @param props.logger The logger to use. | ||
| * @param props.muteStates The mute states for video and audio. | ||
| * @param props.matrixRTCSession The matrix RTC session to join. |
Member
There was a problem hiding this comment.
For what it's worth I think we should stick to putting these kinds of comments in the interface definition rather than on the function, generally. It's a little easier to pull up the docs for each property while writing a function call that way.
Member
Author
There was a problem hiding this comment.
Yes it feels a bit strange to me also, but I am not familiar with js doc.
It looks like lint requires them because we are doing destructuring/unpacking of the arguments in the signature.
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
3 participants
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.
I noticed that some docs were out-dated, so adding some script to add some basic checks.
It will not force to add docs on all methods for now, but it will check for missing or dead params for example