Add warning for initial_parameters=...

penelopeysm · penelopeysm · commit 235068ba2028 · 2025-09-30T10:54:13.000+01:00
diff --git a/src/sampler.jl b/src/sampler.jl
@@ -64,6 +64,9 @@ function AbstractMCMC.sample(
     initial_state=loadstate(resume_from),
     kwargs...,
 )
+    if hasproperty(kwargs, :initial_parameters)
+        @warn "The `initial_parameters` keyword argument is not recognised; please use `initial_params` instead."
+    end
     return AbstractMCMC.mcmcsample(
         rng, model, sampler, N; chain_type, initial_params, initial_state, kwargs...
     )
@@ -82,6 +85,9 @@ function AbstractMCMC.sample(
     initial_state=loadstate(resume_from),
     kwargs...,
 )
+    if hasproperty(kwargs, :initial_parameters)
+        @warn "The `initial_parameters` keyword argument is not recognised; please use `initial_params` instead."
+    end
     return AbstractMCMC.mcmcsample(
         rng,
         model,

Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,9 @@ function AbstractMCMC.sample(`
`64`	`64`	`initial_state=loadstate(resume_from),`
`65`	`65`	`kwargs...,`
`66`	`66`	`)`
	`67`	`+ if hasproperty(kwargs, :initial_parameters)`
	`68`	+ @warn "The `initial_parameters` keyword argument is not recognised; please use `initial_params` instead."
	`69`	`+ end`
`67`	`70`	`return AbstractMCMC.mcmcsample(`
`68`	`71`	`rng, model, sampler, N; chain_type, initial_params, initial_state, kwargs...`
`69`	`72`	`)`
`@@ -82,6 +85,9 @@ function AbstractMCMC.sample(`
`82`	`85`	`initial_state=loadstate(resume_from),`
`83`	`86`	`kwargs...,`
`84`	`87`	`)`
	`88`	`+ if hasproperty(kwargs, :initial_parameters)`
	`89`	+ @warn "The `initial_parameters` keyword argument is not recognised; please use `initial_params` instead."
	`90`	`+ end`
`85`	`91`	`return AbstractMCMC.mcmcsample(`
`86`	`92`	`rng,`
`87`	`93`	`model,`