migration-guide: interface vs concrete-class inputs#74
Merged
Conversation
The spec README already states this principle (sections ii of the developer guide) but the migration guide is the document developers read when migrating an external package. Adds an explicit subsection under section 2 with a class-kind/input-type table and a note about how tests that mutate a parameter should hold their own reference rather than retrieve through the (now-interface) input. Surfaced while migrating bModelTest where every model component had been typed against RealScalarParam/IntScalarParam/BoolScalarParam, which precluded passing in derived producers like AsIntScalar or IntSum.
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.
Summary
scripts/migration-guide.mdcovering when to type anInput<>to a spec interface (RealScalar,IntScalar, ...) vs a concrete class (RealScalarParam,IntScalarParam, ...).README.mdalready states this principle (developer guide sections ii) but the migration guide is what developers read when migrating an external package.Surfaced while migrating bModelTest, where every model component had been typed against
RealScalarParam/IntScalarParam/BoolScalarParam. That precluded passing in derived producers likeAsIntScalarorIntSum, which the spec system explicitly supports for read-only inputs.Test plan