Skip to content

fix documentation of car-racing continuous argument #1338

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

Merged
merged 2 commits into from
Apr 2, 2025

Conversation

pertakle
Copy link
Contributor

Description

The description of the continuous argument in the car_racing environment states:

`continuous=True` converts the environment to use discrete action space.

However, this is incorrect. Setting continuous=True actually enables a continuous action space, not a discrete one. This PR corrects the misleading comment.

Type of change

Please delete options that are not relevant.

  • Documentation only change (no code changed)

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

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 but continuous should stay as True, rather the description should be updated to accurately reflect its implementation meaning

@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit 6e8227a into Farama-Foundation:main Apr 2, 2025
12 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.

2 participants