docs: point graphics-block docstrings at |GraphicsBlockOptions| - #613
Merged
Conversation
VehiclePlot, ArmPlot, and MultiRotorPlot are all GraphicsBlock subclasses (bdsim), so their **blockargs now also flows through GraphicsBlock's own kwargs (movie, timestamp, timestamp_fmt, watch -- see petercorke/bdsim#75) in addition to Block's. Their blockargs docstring line pointed only at Block.__init__ via |BlockOptions|, silently omitting the graphics-level options. Added |GraphicsBlockOptions| (mirroring the existing |BlockOptions| pattern -- same raw-html substitution, redefined per-repo since there's no intersphinx mapping to bdsim's docs) and pointed these three blocks at it instead. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
petercorke
force-pushed
the
docs/graphics-block-options
branch
from
August 21, 2026 05:41
5c722f0 to
2c487c7
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #613 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 142 142
Lines 13898 13898
=====================================
Misses 13898 13898 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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
Companion PR to bdsim#75, which promotes `watch` from a `Scope`-only parameter to a shared `GraphicsBlock.init` parameter -- these three RTB blocks now genuinely accept `watch=True` once that lands, not just document-in-theory.
Test plan