docs: sync documentation with actual exported API#281
Merged
Conversation
- Add missing instance cache utilities to Utilities import examples: setCachedInstance, replaceCachedInstance, releaseCachedInstance, getReferenceCount (both README.md and README.zh-CN.md) - Add missing group linkage utilities: getInstanceGroup, isInGroup, clearGroups (both README.md and README.zh-CN.md) - Add missing useEcharts options to README.zh-CN.md API table and code example: autoResize, initOpts, onError https://claude.ai/code/session_01BtwYAKUyfuQwAFxuChpmVV
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
2 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.
setCachedInstance, replaceCachedInstance, releaseCachedInstance,
getReferenceCount (both README.md and README.zh-CN.md)
clearGroups (both README.md and README.zh-CN.md)
code example: autoResize, initOpts, onError
https://claude.ai/code/session_01BtwYAKUyfuQwAFxuChpmVV
Note
Low Risk
Docs-only changes; no runtime, API, or behavior changes, with risk limited to potential documentation inaccuracies.
Overview
Updates documentation to reflect the full exported Utilities API, expanding the README import examples and descriptions to include missing instance-cache helpers (e.g.
setCachedInstance,replaceCachedInstance,releaseCachedInstance,getReferenceCount) and group-linkage helpers (e.g.getInstanceGroup,isInGroup,clearGroups).Also updates
README.zh-CN.md’suseEchartsexample and options table to include missing options:autoResize,initOpts, andonError.Written by Cursor Bugbot for commit e9fafc2. This will update automatically on new commits. Configure here.