docs: review documentation updates for 532cf71d2

[github-actions]

Documentation Update Review

Triggered by commit: 532cf71d2
Generated: 2026-04-14 18:03 UTC
Compare: 3184f6c1b61490264c027d3ace350f5650fb332c...532cf71d2

Affected Documents

Document	Files Changed	Status
Multi-Node Deployment Guide	1 file	✅ Reviewed
PyScript API Reference	1 file	✅ Reviewed

All Changed Files in This Commit

Click to expand

pychron/applications/pychron_application.py
pychron/core/ui/qt/animated_png_editor.py
pychron/core/ui/qt/camera_editor.py
pychron/core/ui/qt/laser_status_editor.py
pychron/core/ui/qt/video_component_editor.py
pychron/core/wait/wait_group.py
pychron/envisage/tasks/wait_pane.py
pychron/experiment/experiment_executor.py
pychron/experiment/plot_panel.py
pychron/experiment/tasks/experiment_panes.py
pychron/experiment/tasks/experiment_task.py
pychron/extraction_line/extraction_line_manager.py
pychron/graph/stacked_graph.py
pychron/pyscripts/pyscript.py

---

Multi-Node Deployment Guide {#multi-node-deployment}

Doc file: docs/multi_node_deployment_guide.md
Matched prefixes: pychron/extraction_line/

Changed Files

• pychron/extraction_line/extraction_line_manager.py

AI Review

Code Change Summary

The changes refactor the timer management system in the ExtractionLineManager class, replacing direct do_after() calls with a centralized timer scheduling and cancellation system. This introduces new private attributes for tracking timers and adds proper cleanup methods that are called during deactivation. The changes improve resource management and prevent potential timer leaks in multi-node deployments.

Documentation Updates Required

• Section/Topic: Startup tests for multi-node setups / Hardware update configuration
  Issue: The documentation may reference the old direct do_after() timer behavior for hardware updates and canvas synchronization, which has been replaced with a managed timer system.
  Suggested update: Update any troubleshooting or configuration sections to mention that hardware updates and canvas synchronization now use managed timers that are properly cancelled during shutdown, which should improve cleanup behavior in multi-node deployments.

• Section/Topic: ZMQ/RPC inter-process communication layer / Connection management
  Issue: The addition of proper timer cleanup (_cancel_delayed_updates()) during deactivation affects how extraction line managers clean up resources when shutting down communication with other nodes.
  Suggested update: Note that extraction line manager shutdown now includes automatic cancellation of pending hardware update and canvas sync operations, which improves clean disconnection from other nodes in the multi-node setup.

• Section/Topic: Troubleshooting / Resource cleanup
  Issue: The new timer management system changes how resources are cleaned up, which may affect debugging procedures for stuck or hanging processes.
  Suggested update: Add information that timer-related issues during shutdown are now logged with debug messages indicating which timers failed to cancel and why, which can help diagnose communication issues between nodes.

---

PyScript API Reference {#pyscript-api}

Doc file: docs/pyscript_api_reference.md
Matched prefixes: pychron/pyscripts/

Changed Files

• pychron/pyscripts/pyscript.py

AI Review

Code Change Summary

The changes are internal refactoring to the PyScript class implementation. The _setup_wait_control() method received a return type annotation, and the manual wait control management logic was replaced with a call to self.manager.wait_group.ensure_control(wd). These are implementation details that don't affect the public PyScript API interface or available commands.

No Updates Required

These changes are internal implementation improvements that don't modify any PyScript DSL commands, parameters, syntax, or available context variables. The PyScript API Reference documents the user-facing scripting language interface, and since no public API elements were added, removed, or changed, no documentation updates are necessary.

---

This file was auto-generated by scripts/doc_audit.py. A human must review and apply any changes to the documentation.