chore(docs): replace @remark with @remarks per TSDoc spec #77
Conversation
- TSDoc specifies the tag name as `@remarks` (not `@remark`). - This aligns our comments with the spec and improves tooling support. - No runtime behavior changes. - Ref: https://tsdoc.org/pages/tags/remarks/
🦋 Changeset detectedLatest commit: a90d70a The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
WalkthroughPatch changeset added for two packages and TSDoc tags updated from @remark to @remarks in type definitions. No code logic, signatures, or runtime behavior changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying react-native-youtube-bridge-example with
|
| Latest commit: |
a90d70a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://27792d33.react-native-youtube-bridge-example.pages.dev |
| Branch Preview URL: | https://docs-tsdoc-remarks.react-native-youtube-bridge-example.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.changeset/funny-baths-carry.md (1)
6-11: Fix bare URL in changeset to satisfy markdownlint (MD034)Wrap the reference link to avoid “Bare URL used”.
Apply this patch:
- - Ref: https://tsdoc.org/pages/tags/remarks/ + - Ref: <https://tsdoc.org/pages/tags/remarks/>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
.changeset/funny-baths-carry.md(1 hunks)packages/core/src/types/index.ts(2 hunks)packages/react-native-youtube-bridge/src/types/youtube.ts(2 hunks)
🧰 Additional context used
🧬 Code graph analysis (2)
packages/react-native-youtube-bridge/src/types/youtube.ts (3)
packages/react-native-youtube-bridge/src/YoutubeView.tsx (2)
YoutubeView(16-189)useInlineHtml(41-57)packages/react-native-youtube-bridge/src/YoutubeView.web.tsx (1)
YoutubeView(9-92)packages/web/src/YoutubePlayer.tsx (1)
YoutubePlayer(11-237)
packages/core/src/types/index.ts (4)
packages/web/src/YoutubePlayer.tsx (1)
YoutubePlayer(11-237)packages/core/src/WebYoutubePlayerController.ts (1)
WebYoutubePlayerController(10-377)packages/react-native-youtube-bridge/src/YoutubeView.web.tsx (1)
YoutubeView(9-92)packages/react-native-youtube-bridge/src/hooks/useCreateLocalPlayerHtml.ts (1)
YoutubePlayerVars(6-212)
🪛 markdownlint-cli2 (0.17.2)
.changeset/funny-baths-carry.md
11-11: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (6)
packages/core/src/types/index.ts (4)
121-127: Swapped to @remarks — looks good for autoplay docsChange aligns with TSDoc spec, no API/runtime impact.
128-135: Controls: @remarks tag update is correctSpec-compliant and keeps intent clear.
155-160: Playsinline: @remarks usage is correctReads well and matches platform guidance.
171-175: Origin: @remarks tag update looks goodThe bullet points are clear and consistent with how origin/baseUrl are consumed elsewhere.
| * @remarks | ||
| * After the change, you will not be able to disable related videos. Instead, if the `rel` parameter is set to `false, related videos will come from the same channel as the video that was just played. | ||
| */ | ||
| rel?: boolean; |
There was a problem hiding this comment.
Fix backtick typo in “rel” documentation
There’s an unclosed inline code fence around false, which can break formatting in generated docs.
Apply this patch:
- * After the change, you will not be able to disable related videos. Instead, if the `rel` parameter is set to `false, related videos will come from the same channel as the video that was just played.
+ * After the change, you will not be able to disable related videos. Instead, if the `rel` parameter is set to `false`, related videos will come from the same channel as the video that was just played.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * @remarks | |
| * After the change, you will not be able to disable related videos. Instead, if the `rel` parameter is set to `false, related videos will come from the same channel as the video that was just played. | |
| */ | |
| rel?: boolean; | |
| * @remarks | |
| * After the change, you will not be able to disable related videos. Instead, if the `rel` parameter is set to `false`, related videos will come from the same channel as the video that was just played. | |
| */ | |
| rel?: boolean; |
🤖 Prompt for AI Agents
In packages/core/src/types/index.ts around lines 163 to 166, the JSDoc for `rel`
contains an unclosed inline code fence around false which breaks formatting in
generated docs; fix it by wrapping false in backticks (`false`) so the sentence
reads "...if the `rel` parameter is set to `false`, related videos..." and
ensure punctuation spacing remains correct.
@remarks(not@remark).Summary by CodeRabbit
Documentation
@remarkstag for multiple properties across core and React Native packages.Chores