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 documentation of observation format in Simple World Comm #1212

Conversation

pandyah5
Copy link
Contributor

@pandyah5 pandyah5 commented Jun 5, 2024

Description

This PR is a documentation change for the Simple World Comm environment. It requires no dependencies to reproduce.

Fixes #1207

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

Screenshots

I tried following the steps in the contribution guide to generate the HTMLs for environments but I faced an error. When I run the _scripts/gen_envs_mds.py script it gives me a module not found error for 'multi_agent_ale_py'. I will make a detailed issue following this. But I feel it's quite a harmless change to push given that its just documentation.

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

@pandyah5
Copy link
Contributor Author

Hi @elliottower, just wanted to bring your attention to this PR. Let me know if it requires any changes, would be glad to add them!

Copy link
Member

@jjshoots jjshoots left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the contribution!

@jjshoots jjshoots merged commit 46d92e0 into Farama-Foundation:master Jun 21, 2024
43 of 46 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] Potential information mismatch in the Simple World Comm environment
2 participants