gaspersic/Gymnasium
1
0
Fork 0
mirror of https://github.com/Farama-Foundation/Gymnasium.git synced 2025-08-01 06:07:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix the doc filter to check only args values (#416)

Browse Source
This commit is contained in:
Valentin
2023-03-30 14:23:50 +02:00
committed by GitHub
parent dd57ef8329
commit 4577717bc9
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/conf.py
View File

@@ -72,9 +72,9 @@ autodoc_preserve_defaults = True
# the class docstring. # the class docstring.
def remove_lines_before_parameters(app, what, name, obj, options, lines): def remove_lines_before_parameters(app, what, name, obj, options, lines):
if what == "class": if what == "class":
# ":" represents args values such as :param: or :raises: # ":param" represents args values
first_idx_to_keep = next( first_idx_to_keep = next(
(i for i, line in enumerate(lines) if line.startswith(":")), 0 (i for i, line in enumerate(lines) if line.startswith(":param")), 0
) )
lines[:] = lines[first_idx_to_keep:] lines[:] = lines[first_idx_to_keep:]