From 3180154fa6389420b92d18181294f1ae25e58fae Mon Sep 17 00:00:00 2001 From: Dominik Roth Date: Wed, 11 Oct 2023 11:37:46 +0200 Subject: [PATCH] Added docstring to deprecated 'fancy_gym.make' --- fancy_gym/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/fancy_gym/__init__.py b/fancy_gym/__init__.py index c646aef..c3adaad 100644 --- a/fancy_gym/__init__.py +++ b/fancy_gym/__init__.py @@ -11,4 +11,7 @@ ALL_GYM_MOVEMENT_PRIMITIVE_ENVIRONMENTS = MOVEMENT_PRIMITIVE_ENVIRONMENTS_FOR_NS def make(*args, **kwargs): + """ + As part of the refactor of Fancy Gym and upgrade to gymnasium the use of fancy_gym.make has been discontinued. Regular gym.make should be used instead. For more details check out the github README. If your codebase was build for older versions of Fancy Gym and relies on the old behavior and dependency versions, please check out the legacy branch. + """ raise Exception('As part of the refactor of Fancy Gym and upgrade to gymnasium the use of fancy_gym.make has been discontinued. Regular gym.make should be used instead. For more details check out the github README. If your codebase was build for older versions of Fancy Gym and relies on the old behavior and dependency versions, please check out the legacy branch.')