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

[Bug Report] Docu link to minigrid/core/constants.py broken #431

Open
1 task done
turbotimon opened this issue Apr 30, 2024 · 3 comments
Open
1 task done

[Bug Report] Docu link to minigrid/core/constants.py broken #431

turbotimon opened this issue Apr 30, 2024 · 3 comments

Comments

@turbotimon
Copy link
Contributor

Describe the bug

In many environment pages, there is this sentence, but the link is broken.

OBJECT_TO_IDX and COLOR_TO_IDX mapping can be found in minigrid/core/constants.py

e.g. here: https://minigrid.farama.org/main/environments/minigrid/DoorKeyEnv/#observation-encoding

Possible should point directly to gitub? https://github.com/Farama-Foundation/Minigrid/blob/master/minigrid/core/constants.py

Checklist

  • I have checked that there is no similar issue in the repo (required)
@pseudo-rnd-thoughts
Copy link
Member

Could you make a PR to fix this

@turbotimon
Copy link
Contributor Author

turbotimon commented Apr 30, 2024

Happy to do so, however need some help to get started as i'm not (yet) familiar with sphinx..

I think it would be best if the /minigrid/core/constants.py would also be rendered under https://minigrid.farama.org/_modules/ so we can directly link to it (and to the right release version). I don't think link it directly to github is a good idea..

If that is not possible, I would change the text like this (italic is new):

What do you think?

@pseudo-rnd-thoughts
Copy link
Member

Apologies for not originally replying, yes this is a good idea

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

No branches or pull requests

2 participants