Starflight-code / pioneer-robotics-2022

Pioneer Robotics 2022 Code
GNU General Public License v3.0
0 stars 1 forks source link

[Feature] Impliment Full Internal Documentation #29

Closed Starflight-code closed 1 year ago

Starflight-code commented 1 year ago

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] Internal documentation has not been fully fleshed out, this should be a goal to increase maintainability. This is especially important when we add more team members or onboard existing members to the programming team.

Describe the solution you'd like A clear and concise description of what you want to happen. Create a standardized format for documentation on each unique variable and class method.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered. N/A

Additional context Add any other context or screenshots about the feature request here. N/A

Starflight-code commented 1 year ago

All common methods have documentation. This is an ongoing concern but everything is resolved as of now. Re-open if the code base gets out of control again.