Fix consistency-check activation instructions - #281
Open
Gonghan-Princess wants to merge 1 commit into
Open
Gonghan-Princess wants to merge 1 commit into
Gonghan-Princess wants to merge 1 commit into
Conversation
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.
The consistency-check guide currently recommends assigning
anytree.config.ASSERTIONS = Trueafter importinganytree, but the node and rendering modules have already copied the original setting by then. Following that example leaves their checks disabled.Replace it with Python and POSIX shell examples that set
ANYTREE_ASSERTIONS=1before the first import, including imports through dependencies. Explain why changing the setting afterward does not enable checks in already imported modules. Runtime behavior is unchanged.Refs #279.
Validation on Python 3.12.10:
diffon PATH and LF reference fixtures; no fixture changes are included.AI assistance: OpenAI Codex helped investigate the issue, draft the documentation, and run validation. No third-party code was copied into this change.