Skip to content

docs: stop documenting private imageBundles property#1099

Merged
redfish4ktc merged 1 commit into
mainfrom
docs/image_bundles_update
Jul 6, 2026
Merged

docs: stop documenting private imageBundles property#1099
redfish4ktc merged 1 commit into
mainfrom
docs/image_bundles_update

Conversation

@redfish4ktc

@redfish4ktc redfish4ktc commented Jul 5, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown

commit 5f189e7 made ImageBundlePlugin.imageBundles private (it is plugin-internal state and was never released), but several docs still presented it as public API.

Overview

  • packages/website/docs/usage/image-bundles.md: drop the plugin.imageBundles.length inspection example (it no longer compiles) and reword the runtime-management prose to describe only the supported public operations (removeImageBundle, getImageFromBundles).
  • CHANGELOG.md: the Unreleased migration note pointed read-only consumers at ?.imageBundles. Replace it with ?.getImageFromBundles(key), the actual public read-only API used by CellsMixin.postProcessCellStyle, and document its null/undefined semantics.

No production code changes. The auto-generated TypeDoc API pages under packages/website/generated/api-docs/ already reflect the private visibility and regenerate on build.

Notes

Docs-only fix, no new changelog entry needed (it only corrects existing unreleased changelog text), hence skip-changelog.

Summary by CodeRabbit

  • Documentation
    • Updated migration guidance for image bundle key resolution to use the supported runtime lookup method, including clearer handling of missing matches.
    • Refined the image bundles usage guide to better explain runtime bundle management and show how to remove bundles and resolve keys programmatically.

@redfish4ktc
docs: stop documenting the private ImageBundlePlugin.imageBundles pro…
c125393 
…perty

Commit 5f189e7 made ImageBundlePlugin.imageBundles private, but the docs still presented it as public API.

- image-bundles.md: drop the plugin.imageBundles.length inspection example and reword the runtime-management prose
  to describe only the supported operations (removeImageBundle, getImageFromBundles)
- CHANGELOG.md: replace the read-only access guidance that pointed at ?.imageBundles with ?.getImageFromBundles(key),
  the actual public read-only API used by CellsMixin.postProcessCellStyle
@redfish4ktc redfish4ktc added documentation Improvements or additions to documentation skip-changelog Do not include in Changelog and Release Notes labels Jul 5, 2026
@coderabbitai

coderabbitai Bot commented Jul 5, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

Walkthrough

Documentation and changelog text were updated to recommend using ImageBundlePlugin.getImageFromBundles(key) and removeImageBundle(bundle) for runtime bundle management and key resolution, replacing prior guidance based on the imageBundles property.

Changes

Docs and changelog update

Layer / File(s) Summary
Update migration guidance and usage examples
CHANGELOG.md, packages/website/docs/usage/image-bundles.md		 Changelog and docs now recommend getImageFromBundles(key) (returning null/undefined) and removeImageBundle(bundle) instead of accessing the imageBundles property directly.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • maxGraph/maxGraph#1050: Introduces the ImageBundlePlugin and getImageFromBundles API that this PR's docs/changelog now recommend using.
  • maxGraph/maxGraph#1052: Makes imageBundles private, aligning with this PR's removal of guidance to access that property directly.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title is concise, conventional-commits compliant, and accurately describes the main docs-only change.
Description check ✅ Passed The description clearly explains the change, rationale, and notes, though it omits the template's checklist section.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sonarqubecloud

sonarqubecloud Bot commented Jul 5, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@redfish4ktc redfish4ktc changed the title docs: stop documenting the private ImageBundlePlugin.imageBundles property docs: stop documenting private imageBundles property Jul 6, 2026
@redfish4ktc redfish4ktc merged commit 9e573d4 into main Jul 6, 2026
8 checks passed
@redfish4ktc redfish4ktc deleted the docs/image_bundles_update branch July 6, 2026 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation skip-changelog Do not include in Changelog and Release Notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@redfish4ktc