docs: name PYAUTO_TEST_MODE explicitly in should_visualize docstring - #1417
Merged
Conversation
The docstring said 'If PyAutoFit test mode is on', naming the product rather than the environment variable. That phrasing leads readers to invent `PYAUTOFIT_TEST_MODE`, which nothing reads — the canonical knob is `PYAUTO_TEST_MODE` (autonerves/test_mode.py). Companion to PyAutoCTI#95. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JiU4VbBD9X6jPYJMCx3boh
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
1 participant
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.
Companion to PyAutoLabs/PyAutoCTI#95 / PyAutoLabs/PyAutoCTI#96.
Visualizer.should_visualize's docstring point 5 said:Naming the product rather than the environment variable invites readers to invent
PYAUTOFIT_TEST_MODE, which nothing in the stack reads. The canonical knob isPYAUTO_TEST_MODE(PyAutoNerves/autonerves/test_mode.py:14, alongsidePYAUTO_TEST_MODE_SAMPLES).That exact misreading is what produced the dead fixture fixed in PyAutoCTI#96. Docstring-only change; no behaviour change.