search

srobo / competition-simulator

A simulator for Student Robotics Virtual Competitions
https://studentrobotics.org/docs/simulator/
MIT License
8 stars 2 forks source link

Validate API consistency for SR2024 #407

Closed PeterJCLaw closed 9 months ago

PeterJCLaw commented 10 months ago

Review the API vs the docs and the kits, check that we understand the differences and that they're documented.

PeterJCLaw commented 10 months ago

https://github.com/srobo/competition-simulator/issues/354 may be relevant here.

PeterJCLaw commented 9 months ago

Based on testing the docs against the code from this repo there's a few changes we need. Mostly this is on the docs side, though the Robot initialiser also needs some tweaks.

https://github.com/srobo/docs/issues/537 captures the docs issues, I'll get a PR up for the Robot initialiser shortly.