Farama-Foundation / Gymnasium-Robotics

A collection of robotics simulation environments for reinforcement learning
https://robotics.farama.org/
MIT License
485 stars 79 forks source link

update observation space docstring for `fetch` `pick_and_place` `push` `slide` environments #197

Closed SethPate closed 7 months ago

SethPate commented 7 months ago

Description

The docstring for the observations space in the Fetch Push, Slide, PickAndPlace tasks has a typo. I didn't find a similar problem in Reach. This is only a change to the docstring.

Fixes # (issue)

Type of change

Screenshots

n/a

Checklist:

Kallinteris-Andreas commented 7 months ago

1) can you run pre-commit? 2) can you point to the code that corresponds to the changed documentation (with a perma-link) Thanks

SethPate commented 7 months ago

Here's the relevant code: https://github.com/Farama-Foundation/Gymnasium-Robotics/blob/f2754e19011a6ef329a40efc92dfa4bad81a22d3/gymnasium_robotics/envs/fetch/fetch_env.py#L205C1-L205C51

I'm seeing the same failure on pre-commit, not sure what would cause it to break.

Kallinteris-Andreas commented 7 months ago

I will merge as soon as I fix the CI situation

Kallinteris-Andreas commented 7 months ago

The perma-link provided in a previous post was for the oldmujoco-py based version, for context new version: https://github.com/Farama-Foundation/Gymnasium-Robotics/blob/f2754e19011a6ef329a40efc92dfa4bad81a22d3/gymnasium_robotics/envs/fetch/fetch_env.py#L314-L338