fix(docs): use Data.VectorField qualification instead of dotted using (tenet 2 compliant) - #26
Merged
Merged
Conversation
The dotted form using CTBase.Data: VectorField is rejected by the test_no_import.jl regression guard (Handbook tenet 2). Replace it with using CTBase: Data and qualify all call sites as Data.VectorField, Data.Hamiltonian, Data.HamiltonianVectorField.
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.
Problem
PR #25 used
using CTBase.Data: VectorField, Hamiltonian, HamiltonianVectorFieldto fix theUndefVarErrorin@exampleblocks. However, this dottedusing Pkg.Subform is rejected by thetest_no_import.jlregression guard (Handbook tenet 2):Fix
Replace the dotted
usingwith the qualified call-site approach:All
VectorField,Hamiltonian, andHamiltonianVectorFieldcalls in@exampleblocks are now qualified withData..Files changed
docs/src/lie_derivative_bracket.mddocs/src/lie_macro.mddocs/src/lift.mddocs/src/poisson.mddocs/src/time_derivative.mdVerification
julia --project=docs docs/make.jl— builds with zero@exampleerrorsPkg.test(; test_args=["test/suite/meta/test_no_import.jl"])— 13420 tests pass, 0 failures