search

PhotonVision / photonvision

PhotonVision is the free, fast, and easy-to-use computer vision solution for the FIRST Robotics Competition.
https://photonvision.org
GNU General Public License v3.0
260 stars 169 forks source link

Specify units when using geometry classes #1362

Open DeltaDizzy opened 2 months ago

DeltaDizzy commented 2 months ago

From the feedback thread:

More definition of the units in the docs would be great. Me and my team had a lot of trouble configuring robotToCam this year due to a overall lack of documentation on the units of the variables in the docs. Using AdvantageScope helped us figure out this issue, which we did do, admittedly a little late.

We need to go through the docs and highlight the units that are used in any code block. Could use comments, but maybe look into using units overloads? Need to decide if we want to make that the recommended usage pattern. This is especially relevant for transform definitions, but are there any other spots that could need it?

mdurrani808 commented 2 months ago

Kinda eh on the units integration until it gets more mainstream support. Agree we need to highlight more units, but recommendation should always punt / link to WPILib docs and conventions since we cannot cover all of the cases of units.