Are there docs for this project somewhere?

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

210 stars 26 forks source link

Are there docs for this project somewhere? #56

Open AndKaminer opened 10 months ago

AndKaminer commented 10 months ago

Hi all. I was wondering if there is API documentation for the project somewhere. If there isn't, I'd be happy to write some up. I'm on winter break, so I have nothing better to do.

MarcCote commented 10 months ago

We don't have proper documentation other than the README.md. If you want to give it a go, that would be very useful for the community. :)

MarcCote commented 10 months ago

A first step could be to improve the number and quality of __docstring__ in the code.