search

Jath-Alison / ART

MIT License
1 stars 0 forks source link

Normalize return descriptions for getter methods #3

Open Jath-Alison opened 3 months ago

Jath-Alison commented 3 months ago

Turns out, I wasn't being consistant with getter discriptions. SimpleMotors use this format:

Returns The command the motor is set to, as a percentage of the max

While PID uses this one:

Returns double (the output of the P term)

Additionally, some of the other stuff in the PID also uses this:

Returns double - the number of seconds the error has remained in the settleZone

Make them all the same. Make it look good, make it readable. Good Luck. Lowish Priority, but please finish by the end of the week.

Jath-Alison commented 3 months ago

This also needs to get fixed in the upcoming Vec2 class and whatever else I get done before this issue is resolved.