Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rktl Comments and Documentation #147

Open
wants to merge 109 commits into
base: sim-refactor
Choose a base branch
from

Conversation

Abuynits
Copy link
Contributor

Added comments for the parameters, return, and overview of each function in the following locations:
rktl_sim/src/simulator/sim.py
rktl_sim/nodes/simulator
rktl_autonomy/nodes/rocket_league_agent
rktl_autonomy/src/rktl_autonomy/_ros_interface.py
rktl_autonomy/src/rktl_autonomy/rocket_league_interface.py
rktl_autonomy/scripts/train_rocket_league.py

Note: I marked questions/things that I did not know with "TODO:"+ some text.

Abuynits added 30 commits June 12, 2022 12:17
added comments for the specific functions
changed comment structure for old functions
included comments for new return values as global variables in the object
1:moved sim environment paramters to the init fucntions
2:created update function that calls the create car function, and does not create new subscribers
3:all paramters now use custom get_sim_param function for generation of properties
4:added comments about todos in sim.py
1. split up init function into get_car_properties and rest
2. reset function: clears the system state
- resets the car to the desired position and orientation given an input of values
3. added comments to explain what these functions do
Abuynits and others added 30 commits July 20, 2022 00:24
enabled creating cars and generating ball without reseting all of the sim
refactored create_car_cb, delete_car_cb, reset_cb to work better
added some documentation and comments
fixed bugs with calling rospy.getsimparam over self.getsimparam
add pull argument to docker build call in server run
Update .gitignore, removes stupid DSstore file! lets go
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants