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

Update basic_usage.md #1232

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Conversation

Ricardicus
Copy link
Contributor

@Ricardicus Ricardicus commented Oct 25, 2024

Description

I was following the basic usage example from the documentation and ran into:

$ pip install gymnasium[box2d]                    
zsh: no matches found: gymnasium[box2d]

It turns out one needs to wrap that argument into a single string.
The gymnasium error message for DependencyNotInstalled does this:

gymnasium.error.DependencyNotInstalled: pygame is not installed, run `pip install "gymnasium[box2d]"`

So this is a minor documentation fix.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • [x ] Documentation only change (no code changed)

Screenshots

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
  • [ x] 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

@Kallinteris-Andreas
Copy link
Collaborator

This is due to zsh Behaviour

@Kallinteris-Andreas Kallinteris-Andreas merged commit 0e94c46 into Farama-Foundation:main Oct 25, 2024
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.

2 participants