Andover-Robotics / ARC-Core

This is the combined common code base for Andover Robotics Club, packaged in a library.
0 stars 9 forks source link

Configuration #6

Closed broad-well closed 6 years ago

broad-well commented 6 years ago

Please take a look at this proposed implementation for configuration. Configuration support, as discussed in its Project description, is meant for the retrieval of volatile parameters from the phone's filesystem. This practice saves a significant amount of turnaround time and consequently allows for greater efficiency.

More documentation might be necessary, especially for the "standard directory for configuration files" reference in Configuration.fromPropertiesFile.

broad-well commented 6 years ago

I think it'd be a good idea to incorporate some examples in the TeamCode module (just as FTC does in FtcRobotController).

Also, Codacy doesn't like the inline initialization that I included for schemaProvider in ConfigurationTest. The alternatives for Java 7 are Guava and Kotlin. Pick your poison or ignore Codacy.

justinz3 commented 6 years ago

I don't think I understand the purpose of the changes you have been making.

If you want me to review your changes, could you explain what they are trying to do?

broad-well commented 6 years ago

@jzhu2020 Are you referring to the last commit or this PR?

justinz3 commented 6 years ago

I guess I was referring specifically to the configuration changes. So the PR in general.

broad-well commented 6 years ago

This is the proposed implementation for the Configuration Project, which has the following description:

Parameters that require frequent tweaks during the season should be defined in configuration files for quick turnaround times. (You don't want to recompile the entire app just to change a drivetrain ratio, correct?)

justinz3 commented 6 years ago

Thanks, that's more clear now.

However, I don't think I understand how you did it.

broad-well commented 6 years ago

Have you taken a look at the source? If the documentation is not clear to you, feel free to comment directly on them. (Hover over the line and you'll find a blue "plus" button next to the line number)

justinz3 commented 6 years ago

I'll try commenting on anything I don't understand then.

broad-well commented 6 years ago

You are reviewing the code without JavaDocs. Check out the "Files Changed" tab for this PR.