docs: improve docs

README.md

@@ -1,6 +1,6 @@
 # Stable Gym
 
-[![Stable Gym CI](https://github.com/rickstaa/stable-gym/actions/workflows/stable_gym.yml/badge.svg)](https://github.com/rickstaa/stable-gym/actions/workflows/stable_gym.yml)
+[![Stable Gym](https://github.com/rickstaa/stable-gym/actions/workflows/stable_gym.yml/badge.svg)](https://github.com/rickstaa/stable-gym/actions/workflows/stable_gym.yml)
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/rickstaa/stable-gym)](https://github.com/rickstaa/stable-gym/releases)
 [![Python 3](https://img.shields.io/badge/Python->=3.8-brightgreen)](https://www.python.org/)
 [![codecov](https://codecov.io/gh/rickstaa/stable-gym/branch/main/graph/badge.svg?token=RFM3OELQ3L)](https://codecov.io/gh/rickstaa/stable-gym)

examples/use_stable_gym.py

@@ -4,9 +4,9 @@
 # ENV_NAME = "stable_gym:Oscillator-v1"
 # ENV_NAME = "stable_gym:CartPoleCost-v1"
 # ENV_NAME = "stable_gym:SwimmerCost-v1"
-# ENV_NAME = "stable_gym:FetchReachCost-v1"
+ENV_NAME = "stable_gym:FetchReachCost-v1"
 # ENV_NAME = "stable_gym:MinitaurBulletCost-v1"
-ENV_NAME = "stable_gym:QuadXHoverCost-v1"
+# ENV_NAME = "stable_gym:QuadXHoverCost-v1"
 
 if __name__ == "__main__":
     env = gym.make(ENV_NAME, render_mode="human")

stable_gym/envs/biological/oscillator/README.md

@@ -44,7 +44,7 @@ $$
 In addition to the observations, the cost and a termination and truncation boolean, the environment also returns an info dictionary:
 
 ```python
-[observation, info_dict]
+[observation, cost, termination, truncation, info_dict]
 ```
 
 The info dictionary contains the following keys:

stable_gym/envs/biological/oscillator_complicated/README.md

@@ -47,7 +47,7 @@ $$
 In addition to the observations, the cost and a termination and truncation boolean, the environment also returns an info dictionary:
 
 ```python
-[observation, info_dict]
+[observation, cost, termination, truncation, info_dict]
 ```
 
 The info dictionary contains the following keys:

stable_gym/envs/robotics/fetch/fetch_reach_cost/README.md

@@ -35,9 +35,9 @@ In addition to the observations, the cost and a termination and truncation boole
 
 Compared to the original [FetchReach-v2](https://robotics.farama.org/envs/fetch/reach/) environment, the following keys were added to this info dictionary:
 
-*   **reference**: The reference position (x,y,z) that the FetchReach is tracking.
-*   **state\_of\_interest**: The state that should track the reference (SOI).
-*   **reference\_error**: The error between SOI and the reference.
+*   **reference**: The reference position (x,y,z) that the FetchReach is tracking (i.e. the goal position).
+*   **state\_of\_interest**: The state that should track the reference (SOI) (i.e. the end-effector position).
+*   **reference\_error**: The error between SOI and the reference (i.e. the error between the end-effector position and the goal position).
 
 ## How to use