-
-
Notifications
You must be signed in to change notification settings - Fork 95
docs: use correct line highlight for 0.9.x api changes #372
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
Conversation
WalkthroughThe documentation for version 0.9.X has been updated to reflect API changes concerning sound handling and threading. This includes modifications to method signatures, property types, and usage patterns, as well as updated code snippets and clarifications regarding context handling and coroutine dispatchers. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~6 minutes Suggested labels
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ 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. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
documentation/docs/develop/02-extensions/09-api-changes/0.9.mdx (2)
74-88
: Prefer separate blocks or start/end markers for clearer diffsThe snippet embeds two full
CustomEntityDefinition
declarations in the same```kotlin
block and relies on single-line// highlight-red|green
comments to indicate changes.
Readers (and some syntax-highlight plug-ins) can misinterpret this as duplicated code rather than an old/new diff. Either:
- Wrap the old & new versions in two distinct code blocks, or
- Keep them in one block but switch to
// highlight-red-start
/// highlight-red-end
(and the green equivalents) so the entire “old” and “new” fragments are visually grouped.This small tweak makes the change more obvious and prevents accidental copy-pastes of the obsolete version.
146-153
: Align highlight style across the page for consistencyEarlier sections use single-line
// highlight-red
/// highlight-green
, while this block adopts the start/end pair. Mixing the two styles works but feels inconsistent. Adopting the start/end form everywhere (or documenting when each variant should be used) will make future maintenance easier.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
documentation/docs/develop/02-extensions/09-api-changes/0.9.mdx
(3 hunks)
🔇 Additional comments (1)
documentation/docs/develop/02-extensions/09-api-changes/0.9.mdx (1)
122-130
: LGTM – correct multi-line highlight syntaxGood move using
highlight-red-start/end
andhighlight-green-start/end
here; it cleanly brackets the before/after lines and fixes the previous mis-highlight.
This PR fixes an error introduced in commit 3d700ea where the wrong line highlight was used in code blocks. This resulted in incorrect styling.
Summary by CodeRabbit