Open
Conversation
Convert all docstrings in the core gym environment files from Google-style (Args/Returns) to NumPy-style (Parameters/Returns with underline separators) format, as requested in f1tenth#156. Files converted: - f110_env.py (F110Env class) - base_classes.py (RaceCar, Simulator classes) - dynamic_models.py (vehicle dynamics functions) - laser_models.py (scan simulation, ray casting) - collision_models.py (GJK collision detection) - rendering.py (EnvRenderer class) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Args:/Returns:) to NumPy-style (Parameters/Returnswith underline separators)f110_env.py,base_classes.py,dynamic_models.py,laser_models.py,collision_models.py,rendering.pyCloses #156
Files changed
f110_env.pyF110Envclass (main gym environment)base_classes.pyRaceCarandSimulatorclassesdynamic_models.pyaccl_constraints,steering_constraint,vehicle_dynamics_ks,vehicle_dynamics_st,pid)laser_models.pyScanSimulator2D, ray tracing, iTTC checks)collision_models.pycollision,collision_multiple,get_vertices)rendering.pyEnvRendererclass (pyglet rendering)Example
Before (Google style):
After (NumPy style):
Test plan