change keyword arg

Author: lrennels

src/core/defs.jl

@@ -58,13 +58,13 @@ find_first_period(comp_def::AbstractComponentDef) = @or(first_period(comp_def),
 find_last_period(comp_def::AbstractComponentDef) = @or(last_period(comp_def), last_period(get_root(comp_def)))
 
 """
-    delete!(md::ModelDef, comp_name::Symbol; delete_unbound_comp_params::Bool=false)
+    delete!(md::ModelDef, comp_name::Symbol; deep::Bool=false)
 
 Delete a `component` by name from `md`.
-If `delete_unbound_comp_params=true` then any external model parameters connected only to 
+If `deep=true` then any external model parameters connected only to 
 this component will also be deleted.
 """
-function Base.delete!(md::ModelDef, comp_name::Symbol; delete_unbound_comp_params::Bool=false)
+function Base.delete!(md::ModelDef, comp_name::Symbol; deep::Bool=false)
     if ! has_comp(md, comp_name)
         error("Cannot delete '$comp_name': component does not exist.")
     end
@@ -81,7 +81,7 @@ function Base.delete!(md::ModelDef, comp_name::Symbol; delete_unbound_comp_param
 
     # Remove external parameter connections
 
-    if delete_unbound_comp_params # Find and delete external_params that were connected only to the deleted component if specified
+    if deep # Find and delete external_params that were connected only to the deleted component if specified
         # Get all external parameters this component is connected to
         comp_ext_params = map(x -> x.external_param, filter(x -> x.comp_path == comp_path, md.external_param_conns))
 

src/core/model.jl

@@ -369,13 +369,13 @@ Add a scalar type parameter `name` with value `value` to the model `m`.
 @delegate set_external_scalar_param!(m::Model, name::Symbol, value::Any) => md
 
 """
-    delete!(m::Model, component::Symbol; delete_unbound_comp_params::Bool=false)
+    delete!(m::Model, component::Symbol; deep::Bool=false)
 
 Delete a `component` by name from a model `m`'s ModelDef, and nullify the ModelInstance.
-If `delete_unbound_comp_params=true` then any external model parameters connected only to 
+If `deep=true` then any external model parameters connected only to 
 this component will also be deleted.
 """
-@delegate Base.delete!(m::Model, comp_name::Symbol; delete_unbound_comp_params::Bool=false) => md
+@delegate Base.delete!(m::Model, comp_name::Symbol; deep::Bool=false) => md
 
 """
     delete_param!(m::Model, external_param_name::Symbol)

test/test_delete.jl

@@ -1,6 +1,6 @@
 module TestDelete
 
-# Test the behavior of the `delete!` function with and without the `delete_unbound_comp_params` kwarg.
+# Test the behavior of the `delete!` function with and without the `deep` kwarg.
 
 using Mimi
 using Test
@@ -36,7 +36,7 @@ run(m1) # run before and after to test that `delete!` properly "dirties" the mod
 
 # Test component deletion that removes unbound component parameters
 m2 = _get_model()
-delete!(m2, :A1, delete_unbound_comp_params = true)
+delete!(m2, :A1, deep = true)
 @test length(Mimi.components(m2.md)) == 1
 @test length(m2.md.external_params) == 2        # :p2_A1 has been removed
 @test !(:p2_A1 in keys(m2.md.external_params))