wpilibsuite / allwpilib

Official Repository of WPILibJ and WPILibC
https://wpilib.org/
Other
1.05k stars 612 forks source link

Method descriptions for all of the SmartDashboard.setDefault* methods are wrong #6334

Open chauser opened 6 months ago

chauser commented 6 months ago

The comments on, and therefore the class documentation descriptions for, all of the SmartDashboard.setDefault* methods (Java) say Gets the current value in the table, setting it if it does not exist., but in fact these methods all return a boolean so they cannot be returning the value from the table. The documented behavior would be pretty useful, but I understand the need to have an indication if the default value could not be set because the table key exists with a different type.

Documentation for the analogous methods in C++ has the same issue.

sciencewhiz commented 6 months ago

Looks like the docs have been wrong ever since the functions were implemented 8 years ago. https://github.com/wpilibsuite/allwpilib/commit/64ebe7f5e50cf756d8621eec05cb6a30f8b362b7#diff-65701be4c8a216555abf8bf0942e1da98b20fef3a0ad44f3095f6d398bd296ebR294