Skip to content

docs: review documentation updates for 82c4016bf#2325

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/auto-update-82c4016bf
Open

docs: review documentation updates for 82c4016bf#2325
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/auto-update-82c4016bf

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 8, 2026

Documentation Update Review

Triggered by commit: 82c4016bf
Generated: 2026-05-08 20:58 UTC
Compare: 7911e3bd1b24941500c5782c5c39daf0f62860d5...82c4016bf

Affected Documents

Document Files Changed Status
DVC Setup Guide 1 file ✅ Reviewed

All Changed Files in This Commit

Click to expand
pychron/dvc/dvc_persister.py
pychron/experiment/experiment_executor.py
pychron/labspy/client.py
pychron/paths.py

DVC Setup Guide {#dvc-setup-guide}

Doc file: docs/dvc_setup_guide.md
Matched prefixes: pychron/dvc/

Changed Files

  • pychron/dvc/dvc_persister.py

AI Review

Code Change Summary

The code changes remove all references to globalv.communication_simulation checks from the DVC persister's post_measurement_save() and save_run_log_file() methods. Previously, these methods would skip saving data to DVC repositories when simulation mode was active to prevent pollution of real data repositories with simulated data. This simulation mode bypass functionality has been completely removed.

Documentation Updates Required

  • Section/Topic: Configuration fields and preferences / Simulation mode behavior
    Issue: If the DVC Setup Guide documents the communication_simulation preference and describes how DVC operations are skipped during simulation mode, this information is now incorrect since the simulation checks have been removed from the persister.
    Suggested update: Remove any references to DVC operations being automatically skipped during simulation mode, or add a warning that simulation mode no longer prevents DVC repository writes and users must manually disable DVC persistence when running simulations.

  • Section/Topic: Failure modes and troubleshooting / Data integrity protection
    Issue: If the guide mentions built-in protections against accidental data pollution during testing/simulation, this protection mechanism no longer exists for DVC operations.
    Suggested update: Add a note that users must manually ensure DVC persistence is disabled when running simulations or tests to avoid writing simulated data to production repositories, since automatic simulation mode detection has been removed from the DVC persister.


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

Generated by doc-maintenance workflow.
Triggered by commit 82c4016.

Co-Authored-By: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant