feat(api): wire up mmToEdge to liquid class transfer #17293
Merged
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.
Overview
Closes AUTH-1292.
This PR wires up the liquid class touch tip property
mmToEdge
to the touch tip execution logic. This follows up #17107 which added the argument to thetouchTip
protocol engine. In order to access this through the API, the argument was added as an optional argument with a default to the core methods. For legacy cores it will raise anAPIVersionError
if supplied with anything other thanNone
(the default). For the engine core, it will pass the arguments to the engine.Since this is only added to the core, the user facing
InstrumentContext
touch tip still usesradius
as the only way to change where the touch tip moves go to in the well. The only place that uses this new argument is in the logic fortransfer_liquid
, which uses the core methods.Test Plan and Hands on Testing
Unit test coverage and testing in previous PR confirmed that the execution logic worked.
Changelog
mm_from_edge
argument to API coretouch_tip
methodsmmToEdge
to touch tip calls.Review requests
There is now a divergence between what the API and engine code calls this argument (
mm_from_edge
) and what the transfer property still has it asmmToEdge
. I prefer usingfrom
since it's more natural english in describing the property. I have not changed anything about the liquid class names yet, but if this should be done in this PR I can do that.There's also the fact that supplying a radius of a value other than
1.0
and ammFromEdge
argument of not None or 0 will cause the engine touch tip implementation to raise. No additional check has been put in the core, though the docstring contains information that this is mutually exclusive. Should we have an additional check or is the engine one enough?Risk assessment
Low.