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.

Sign up for GitHub

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

Jump to bottom

[Proposal] Documentation Frozen Lake #135

Closed
1 task done
MarionPlt opened this issue Nov 16, 2022 · 3 comments
Closed
1 task done

[Proposal] Documentation Frozen Lake #135

MarionPlt opened this issue Nov 16, 2022 · 3 comments
Labels
enhancement New feature or request

Comments

@MarionPlt
Copy link
Contributor

Proposal

Get the is_slippery parameter infos more visible in the documentation

Motivation

When running Frozen Lake for the fisrt time, is_slippery add a default parameter set at true.
It's not explained in the documentation but only in the repository Github.
Can induce some difficulties when learning.
Also the info about this boolean are not easily readable on the documentation page.

Pitch

Get a bigger policy or a title to separate the paragrah to the other ones.
Precise in the description that this parameter is set at true by default.

Alternatives

No response

Additional context

No response

Checklist

  • I have checked that there is no similar issue in the repo
@MarionPlt MarionPlt added the enhancement New feature or request label Nov 16, 2022
@MarionPlt MarionPlt mentioned this issue Nov 16, 2022
Open
@MarionPlt MarionPlt changed the title [Proposal] Proposal title [Proposal] Documentation Frozen Lake Nov 16, 2022
@pseudo-rnd-thoughts
Copy link
Member

pseudo-rnd-thoughts commented Nov 16, 2022 •
edited

Thanks for moving the PR here

Would you be happy to make the PR? You should just need to update docstring in the FrozenLake environment

@MarionPlt
Copy link
Contributor Author

I just opened a PR! :)

@pseudo-rnd-thoughts
Copy link
Member

Addressed in #136

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pseudo-rnd-thoughts @MarionPlt