Skip to content

docs: point graphics-block docstrings at |GraphicsBlockOptions| - #613

Merged
petercorke merged 1 commit into
mainfrom
docs/graphics-block-options
Aug 22, 2026
Merged

docs: point graphics-block docstrings at |GraphicsBlockOptions|#613
petercorke merged 1 commit into
mainfrom
docs/graphics-block-options

Conversation

@petercorke

Copy link
Copy Markdown
Owner

Summary

  • `VehiclePlot`, `ArmPlot`, and `MultiRotorPlot` are all `GraphicsBlock` subclasses (bdsim), so their `**blockargs` now also flows through `GraphicsBlock`'s own kwargs (`movie`, `timestamp`, `timestamp_fmt`, and now `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|` to `conf.py`, mirroring the existing `|BlockOptions|` pattern (same raw-html substitution, redefined per-repo since there's no intersphinx mapping to bdsim's docs today), and pointed these three blocks at it instead.

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

  • `pytest tests/ -k "block or bdsim or Vehicle or ArmPlot or MultiRotor"` -- 24 passed, 6 pre-existing skips
  • Confirmed `ArmPlot(..., watch=True)` constructs and sets `self.watch = True` correctly against the local bdsim#75 branch

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
petercorke force-pushed the docs/graphics-block-options branch from 5c722f0 to 2c487c7 Compare August 21, 2026 05:41
@codecov

codecov Bot commented Aug 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (6e3508b) to head (2c487c7).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@petercorke
petercorke merged commit 902c277 into main Aug 22, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant