[Bug Report] Pong Documentation has the wrong import in sample code

[kuds]

Describe the bug

The PettingZoo Documentation for Atari's Pong has the wrong imports in the AEC and Parallel and lists basketball_pong_v3 instead of pong_v3. With your permission, I want to create a pull request to fix the documentation against the gh-pages branch.

Pong Info

AEC Section

Code example

No response

System info

Environment: Google Colab T4
Python Version: 3.10.12
Torch Version: 2.4.1+cu121
Is Cuda Available: True
Cuda Version: 12.1
Gymnasium Version: 0.28.1
Numpy Version: 1.26.4
PettingZoo Version: 1.24.3
Ray Version: 2.37.0
ALE Version: 0.8.1

Additional context

No response

Checklist

• I have checked that there is no similar issue in the repo

[kuds]

After some further troubleshooting, I realized that the issue was not with the Github Pages branch but with how the gen_envs_mds.py gathers the environments' names. When it tries to match on pong, it returns multiple results and grabs the first one, basketball_pong, and not pong. I will close my original pull request against the gh-pages branch and will create a new one against the master branch with the new fix.

docs/_scripts/gen_envs_mds.py

[David-GERARD]

Hi @kuds,

Thanks for underlining this issue, I'll be happy to review your PR when you submit it!

Important

To edit the documentation, you need to target the branch master, not the branch gh-pages.

Note

gh-pages contains all of the documentation for all of the releases, and is used to generate the website. No manual pushes are made on this branch. However changes to the docs on branch main are pushed to the main(unstable) version of the website (you can change the version with the tab in the lower right corner.

[kuds]

@David-GERARD

Sorry for the delay in getting back to this. I will have some time this week and next to create the pull PR.

Thank you for patience!

[David-GERARD]

Hi @kuds, no problem at all, and happy holidays!