Docstrings, skip hidden files in autogen_rst

docs/autogen_rst.py

@@ -74,7 +74,9 @@ def make_rst(src_root, rst_root, clean=False, overwrite=False, package_prefix=""
     subdir_refs = [
         f"{f}/index"
         for f in files_in_dir
-        if os.path.isdir(os.path.join(src_root, f)) and not f.startswith("_")
+        if os.path.isdir(os.path.join(src_root, f))
+        and not f.startswith("_")
+        and not f.startswith(".")
     ]
     package_index_rst_path = os.path.join(
         rst_root,

tianshou/data/collector.py

@@ -286,6 +286,7 @@ class BaseCollector(ABC):
             (The collector needs the initial obs and info to function properly.)
         :param gym_reset_kwargs: extra keyword arguments to pass into the environment's
             reset function. Only used if reset_before_collect is True.
+
         .. note::
 
             One and only one collection number specification is permitted, either

tianshou/trainer/base.py

@@ -417,7 +417,7 @@ class BaseTrainer(ABC):
         """Perform one training iteration.
 
         A training iteration includes collecting data (for online RL), determining whether to stop training,
-        and peforming a policy update if the training iteration should continue.
+        and performing a policy update if the training iteration should continue.
 
         :return: the iteration's collect stats, training stats, and a flag indicating whether to stop training.
             If training is to be stopped, no gradient steps will be performed and the training stats will be `None`.