docs(wiki): document EventViewer.exportImage in Event Detection guide#373
Draft
HanSur94 wants to merge 1 commit into
Draft
docs(wiki): document EventViewer.exportImage in Event Detection guide#373HanSur94 wants to merge 1 commit into
HanSur94 wants to merge 1 commit into
Conversation
PR #333 added EventViewer.exportImage() for saving the event timeline as PNG/JPEG. The auto-generated API reference already picked this up; this updates the hand-written usage guide to show the call and replaces the stale "context menu" export bullet (no such menu exists in the source) with an accurate description. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013Fxt1VusK6yVsjMLZYfPz4
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.
Summary
PR #333 (merged) added
EventViewer.exportImage(filepath, format)— a public method to save the rendered event-timeline figure as PNG or JPEG. The auto-generatedwiki/API-Reference:-Event-Detection.mdalready picked up the new method signature/docstring via the doc-gen bot, but the hand-writtenwiki/Event-Detection-Guide.mdusage guide didn't mention it.This PR:
viewer.exportImage(...)calls to the EventViewer code sample in the guide.EventViewer.m) with an accurate description ofexportImage, including its error IDs (EventViewer:notRendered,EventViewer:unknownImageFormat).Test plan
wiki/Event-Detection-Guide.md) — no code changed, no tests needed.EventViewer.mhas no context-menu code (the replaced bullet was inaccurate even before this PR).exportImagedocstring inlibs/EventDetection/EventViewer.mand the auto-generated API reference.🤖 Generated with Claude Code
Generated by Claude Code