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

Fix outdated docs for TimeLimit max_episode_steps and add validation. #1149

Merged

Conversation

troiganto
Copy link
Contributor

Description

  • update docstring of TimeLimit.__init__()
  • add assert isinstance(max_episode_steps, int) and max_episode_steps > 0
  • I assume max_episode_steps==0 can be safely disallowed?
  • add tests for both assertions

Fixes #1147

Type of change

Please delete options that are not relevant.

  • 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 commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • 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

@troiganto
Copy link
Contributor Author

Hrm. These errors look very interesting but also unrelated to my changes. Most seem to be type disagreements in the spaces package.

Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, looks good

@pseudo-rnd-thoughts
Copy link
Member

The doctest seem to be failed for unrelated reasons

@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit ad8734d into Farama-Foundation:main Aug 26, 2024
4 of 13 checks passed
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.

[Bug Report] Possibly outdated docstring for TimeLimit max_episode_steps
2 participants