Skip to content

Commit 17f2b10

Browse files
committed
initializeRecipe deprecation
1 parent 0625461 commit 17f2b10

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

src/diffpy/srfit/fitbase/fitresults.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@
6969
initializeRecipe_dep_msg = build_deprecation_message(
7070
"diffpy.srfit.fitbase",
7171
"initializeRecipe",
72-
"FitRecipe.in",
72+
"initialize_recipe_with_results",
7373
removal_version,
74-
new_base="diffpy.srfit.fitbase.FitResults",
74+
new_base="diffpy.srfit.fitbase.FitRecipe",
7575
)
7676

7777

@@ -830,7 +830,14 @@ def resultsDictionary(results):
830830

831831
@deprecated(initializeRecipe_dep_msg)
832832
def initializeRecipe(recipe, results):
833-
"""Initialize the variables of a recipe from a results file.
833+
"""**This function has been deprecated and will be** **removed in
834+
version 4.0.0.**
835+
836+
**Please use**
837+
**diffpy.srfit.fitbase.FitRecipe.initialize_recipe_with_results**
838+
**instead.**
839+
840+
Initialize the variables of a recipe from a results file.
834841
835842
This reads the results from file and initializes any variables (fixed or
836843
free) in the recipe to the results values. Note that the recipe has to be

0 commit comments

Comments
 (0)