search

wpilibsuite / 2024Beta

Repository for Beta Testing of 2024 Software
32 stars 5 forks source link

Java units library needs more documentation #28

Closed agasser closed 9 months ago

agasser commented 10 months ago

The Java units library is not intuitive (thanks to Java generics), so it needs to be well documented. There are a lot of JavaDocs missing, for example, the Velocity class has no class-level documentation. The documentation page has more information about memory usage than actual information about how to use the library. I recommend adding more examples, and a table of the available types (and maybe how to declare and initialize them.)

agasser commented 10 months ago

I'm working on a PR for frc-docs with some suggestions.

agasser commented 9 months ago

Resolved by https://github.com/wpilibsuite/frc-docs/pull/2397