allenai / ScienceWorld

ScienceWorld is a text-based virtual environment centered around accomplishing tasks from the standardized elementary science curriculum.
https://sciworld.apps.allenai.org/
Apache License 2.0
199 stars 24 forks source link

Add PEP 8 compliant api, and add deprecation warnings to camel case api methods. #55

Closed AndKaminer closed 8 months ago

AndKaminer commented 8 months ago

The camel case python API does not follow PEP 8, and I found it a little tricky to tell between scala and python methods. To fix this, I added new, duplicate methods, that follow (in my opinion) pythonic naming convention. Some of the duplicate methods can be seen below:

Screenshot from 2023-12-14 17-03-38

I also added a deprecated_api_warning method to utils.py. Screenshot from 2023-12-14 17-04-07

I then stuck it in to every camel case method. Screenshot from 2023-12-14 17-03-05

Potential follow ups:

Any feedback would be greatly appreciated!