Skip to content

Commit f1f8470

Browse files
committed
Fix VecEnv docstrings (closes #577)
1 parent 720b26b commit f1f8470

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

docs/misc/changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ Others:
6363
- Minor PEP8 fixes in dqn.py (@justinkterry)
6464
- Add a message to the assert in `PPO2`
6565
- Update replay buffer doctring
66+
- Fix `VecEnv` docstrings
6667

6768
Documentation:
6869
^^^^^^^^^^^^^^

stable_baselines/common/vec_env/dummy_vec_env.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ class DummyVecEnv(VecEnv):
1212
multiprocess or multithread outweighs the environment computation time. This can also be used for RL methods that
1313
require a vectorized environment, but that you want a single environments to train with.
1414
15-
:param env_fns: ([Gym Environment]) the list of environments to vectorize
15+
:param env_fns: ([callable]) A list of functions that will create the environments
16+
(each callable return a `Gym.Env` instance when called).
1617
"""
1718

1819
def __init__(self, env_fns):

stable_baselines/common/vec_env/subproc_vec_env.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ class SubprocVecEnv(VecEnv):
6262
``if __name__ == "__main__":`` block.
6363
For more information, see the multiprocessing documentation.
6464
65-
:param env_fns: ([Gym Environment]) Environments to run in subprocesses
65+
:param env_fns: ([callable]) A list of functions that will create the environments
66+
(each callable return a `Gym.Env` instance when called).
6667
:param start_method: (str) method used to start the subprocesses.
6768
Must be one of the methods returned by multiprocessing.get_all_start_methods().
6869
Defaults to 'forkserver' on available platforms, and 'spawn' otherwise.

0 commit comments

Comments
 (0)