docs: review documentation updates for 82c4016bf#2325
Open
github-actions[bot] wants to merge 1 commit into
Open
docs: review documentation updates for 82c4016bf#2325github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
Generated by doc-maintenance workflow. Triggered by commit 82c4016. Co-Authored-By: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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.
Documentation Update Review
Triggered by commit:
82c4016bfGenerated: 2026-05-08 20:58 UTC
Compare:
7911e3bd1b24941500c5782c5c39daf0f62860d5...82c4016bfAffected Documents
All Changed Files in This Commit
Click to expand
DVC Setup Guide {#dvc-setup-guide}
Doc file:
docs/dvc_setup_guide.mdMatched prefixes:
pychron/dvc/Changed Files
pychron/dvc/dvc_persister.pyAI Review
Code Change Summary
The code changes remove all references to
globalv.communication_simulationchecks from the DVC persister'spost_measurement_save()andsave_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_simulationpreference 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.