Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Updated CustomEnvironment tutorial comments #1084

Merged
merged 3 commits into from
Sep 4, 2023

Conversation

GiovanniGrotto
Copy link
Contributor

Description

I added some comments to the CustomEnvironment prisoner tutorial

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have run pytest -v and no errors are present.
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I solved any possible warnings that pytest -v has generated that are related to my code to the best of my knowledge.
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@GiovanniGrotto GiovanniGrotto changed the title Update to CustomEnvironment tutorial comments Updated CustomEnvironment tutorial comments Sep 3, 2023
Copy link
Contributor

@elliottower elliottower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are great thanks. One comment though is to make sure it's clear which of the bullet points are true for all environments, and which are specific for this environment. You had things about prisoner positions and such in the same list as termination truncation etc, probably best to just say something like "the reset method must do the following" and then specify this environment itself does some more additional steps.

But this is much improved so thanks a ton for the help

@elliottower elliottower merged commit ace9b76 into Farama-Foundation:master Sep 4, 2023
@GiovanniGrotto GiovanniGrotto deleted the prisoner_docs2 branch September 5, 2023 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants