docs: improve function bindings documentation with examples #16310
+235
−16
Conversation
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
|
- Improved documentation clarity with natural language explanations - Added clear generic pattern example showing the subscription model - Enhanced MediaQuery and mouse position examples with proper formatting - Explained internal mechanism and key characteristics - Added guidance on when to use createSubscriber
69c2f9f to
15fea4c
Compare
Ocean-OS
requested changes
Jul 7, 2025
|
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.
This pull request significantly enhances the documentation for the
createSubscriberfunction, a crucial but under-documented part of Svelte 5's reactivity system. Key improvements include:Clearer Opening Description: Rewritten in natural language to immediately explain
createSubscriberas a "bridge" between external events and Svelte's reactivity.Comprehensive Examples: Added three detailed examples demonstrating common patterns: a generic reactive utility, a class-based
MediaQueryintegration, and a function-basedmousePositiontracker. These highlight proper Svelte 5 patterns and essential cleanup.Improved JSDoc Structure: Enhanced with clear
@paramtags, multiple@examplesections, a dedicated "Implementation Details" section, and a practical "When to use" guide.This enhancement makes
createSubscribermore intuitive and helps developers confidently integrate external APIs, ensuring proper usage to prevent issues such as memory leaks. Hopefully, we can further clarify one of Svelte 5's powerful features!