frc-docs icon indicating copy to clipboard operation
frc-docs copied to clipboard

Add list of classes with struct support

Open katzuv opened this issue 1 year ago • 6 comments

It'll be nice to have a list of classes which support structs, and what values they hold. It looks like the only way to do this currently is to look through the source code.

katzuv avatar Dec 16 '23 21:12 katzuv

What use case does this help with?

calcmogul avatar Dec 16 '23 21:12 calcmogul

First, just to let people know it exists. Second, for example we today needed to dig through the source code to find that Rotation2d has a struct, and to find out it holds the value in radians and not in degrees.

katzuv avatar Dec 16 '23 21:12 katzuv

Yea, we should document the struct contents somewhere, because you need to know that to actually use it. Sounds like something that should be in API docs though rather than general docs.

calcmogul avatar Dec 16 '23 21:12 calcmogul

Should I open an issue in allwpilib?

katzuv avatar Dec 17 '23 15:12 katzuv

Sure

calcmogul avatar Dec 17 '23 23:12 calcmogul

Are we closing this issue then?

jasondaming avatar Jan 02 '24 22:01 jasondaming