Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Bug Report] Outdated API documentation in custom environment tutorial #669

Closed
1 task done
ernestum opened this issue Aug 11, 2023 · 5 comments · Fixed by #709
Closed
1 task done

[Bug Report] Outdated API documentation in custom environment tutorial #669

ernestum opened this issue Aug 11, 2023 · 5 comments · Fixed by #709
Labels
bug Something isn't working

Comments

@ernestum
Copy link

Describe the bug

The tutorial about writing a custom environment still refers to done instead of terminated and truncated.

Code example

No response

System info

No response

Additional context

No response

Checklist

  • I have checked that there is no similar issue in the repo
@ernestum ernestum added the bug Something isn't working label Aug 11, 2023
@Kallinteris-Andreas
Copy link
Collaborator

@ernestum
want to make a PR to fix it?

@pseudo-rnd-thoughts
Copy link
Member

@kir0ul is in the process of updating the whole tutorial

@kir0ul
Copy link
Contributor

kir0ul commented Aug 13, 2023

Yes, still a work in progress, the new environment template should be up-to-date with the new API: https://github.com/Farama-Foundation/gymnasium-env-template/blob/main/template/%7B%7Benvironment_name%7D%7D/envs/grid_world.py#L101, but I still need to update the Gymnasium docs.

@ernestum
Copy link
Author

Good to know thanks!

@kir0ul
Copy link
Contributor

kir0ul commented Sep 8, 2023

@ernestum if you want to take a look at the refactoring of the tutorial in #709, that'd be helpful 🙂

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants