Farama-Foundation / Minigrid

Simple and easily configurable grid world environments for reinforcement learning

https://minigrid.farama.org/

Other

2.09k stars 604 forks source link

Added docs #222

Closed vairodp closed 2 years ago

vairodp commented 2 years ago

Description

This PR add documentation for the following environments:

blockedunlockpickup
crossing
distshift
doorkey
dynamicobstacles
empty
fetch
fourrooms
gotodoor
keycorridor
lavagap
lockedroom
memory
multiroom
obstrucedmaze
putnear
redbluedoors
unlock
unlockpickup

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update

Checklist:

[x] I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
[ ] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes

rodrigodelazcano commented 2 years ago

Overall looks good to me. I gave a few comments for small additions before merging. Also, could you rebase to the latest commit?

rodrigodelazcano commented 2 years ago

Thank you @vairodp I'm merging this branch. I'll fix the error related to codespell in another PR