[Bug Report] New render API not working

[trigaten]

From this documentation page, running the following yields an error.

import gym
env = gym.make("LunarLander-v2", render_mode="human")

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/opt/anaconda3/envs/vid/lib/python3.9/site-packages/gym/envs/registration.py", line 503, in make
    env = cls(**_kwargs)
TypeError: __init__() got an unexpected keyword argument 'render_mode'

[pseudo-rnd-thoughts]

That documentation update seems a bit early, that PR is still in progress and will be merged soon #2671
For now, please remove the render_mode parameter

[RedTachyon]

Do we have any proper versioning of the documentation repo? It seems the built version is master, and new updates are also pushed to master, which isn't necessarily a great idea. We should probably do it like most other libraries, where you have a docs page for the last stable release, and separate docs for master

[younik]

Hello @trigaten,
Farama-Foundation/gym-docs#124 was the pull to update documentation for #2671; the updated snippets will work when #2671 is merged.
Sorry for not pointing this out clearly. It would be nice to have a mechanism as @RedTachyon pointed out or you can reverse Farama-Foundation/gym-docs#124 and merge it only after #2671
Thanks

[trigaten]

@RedTachyon @younik How exactly should versioned documentation work?
Would we have a branch for each new gym version and have the site build from the most up to date branch?
When would master be pushed to?

[RedTachyon]

So I'm not actually sure what the industry standard is of doing this, but the way I'd envision it is:

• Branch "stable" for the latest release (and the default build target for the website)
• Branch "master" for incremental updates (and maybe as a build target under a subdomain or under a specific path, so that we can access it, but it's not the default that people see)
• When we update the main library from version X to Y, the current "stable" gets pushed to a new branch named vX, and current master gets pushed to "stable"

[DDDOH]

Before the released package can catch up with the current document, any instructions on how to use the old render API? Or when will a new package will get published to match the current document?

or maybe I'll try building from source before the release of a new version

[younik]

Before the released package can catch up with the current document, any instructions on how to use the old render API? Or when will a new package will get published to match the current document?

or maybe I'll try building from source before the release of a new version

Hello, if you want to use the old API and you don't know how it works, you can follow old tutorials, like this one

[DDDOH]

Thanks a lot, that's a good one! Looking forward to the brand new API anyway!

[BlueskyFR]

May I ask why this issue was closed? The case where someone uses an other version than the master branch (so more than 99% of the cases) is still not handled AFAIK

[DDDOH]

It's mainly caused by document and code unmatching. be a little bit patient bro.