Washington-Superbike / Superbike-Firmware

2 stars 3 forks source link

Display cleanup? #6

Closed caslam closed 1 year ago

caslam commented 1 year ago

Took some extra variables and stuff out of display files. Also I put the config file back because it was kind of helpful to have the screen defined before Display.h, but now you have to change the screen type there instead of Main.h.

Chase-Arline commented 1 year ago

This documentation system is really annoying and seems unnecessary. You only changed like 3-4 source files but the documentation makes you commit like 900+ total files?

Chase-Arline commented 1 year ago

Have you tested the code when you have USE_DEBUGGING_SCREEN defined as well as when you do not have it defined?

s-syasir commented 1 year ago

This documentation system is really annoying and seems unnecessary. You only changed like 3-4 source files but the documentation makes you commit like 900+ total files?

Good point, yeah the issue is that it updates all HTML files and modifies them, I guess if there was a way to just avoid those changes? Or perhaps, when committing, dont rerun doxygen, until significant changes are made and then just rerun and have a specific commit tagged as Doxygen

Chase-Arline commented 1 year ago

What does doyxgen give us that normal commenting documentation doesn't? I am not sure the pros are worth the con of maintaining it.

s-syasir commented 1 year ago

What does doyxgen give us that normal commenting documentation doesn't? I am not sure the pros are worth the con of maintaining it.

Good point. The comments are there, I supposed people should just read those and make sense of it. The only advantage is that the HTML files are a bit more organized and easier to read, but yeah, the 900 file commits are annoying to deal with for sure

s-syasir commented 1 year ago

So yeah, Cassandra, if you want, once we review this change and approve it, do another PR for just removing the Doxygen files.

caslam commented 1 year ago

Oh ok! The Doxygen stuff was actually very painless to run, but yeah I'm not sure if people are actually using it.

Also yes the USE_DEBUGGING_SCREEN has been tested!

Chase-Arline commented 1 year ago

did you check for merge conflicts already? git checkout main git merge display to check

caslam commented 1 year ago

No conflicts :(

Chase-Arline commented 1 year ago

Cool, no conflicts is good.

On Sun, Apr 2, 2023, 7:55 AM caslam @.***> wrote:

No conflicts :(

— Reply to this email directly, view it on GitHub https://github.com/Washington-Superbike/ARHMA2021/pull/6#issuecomment-1493363865, or unsubscribe https://github.com/notifications/unsubscribe-auth/ANB6FNKILN2FBBKUK6MOSS3W7GHMRANCNFSM6AAAAAAWQEUGWM . You are receiving this because you commented.Message ID: @.***>

caslam commented 1 year ago

OK last thing, the battery voltage needs to be on there. Sorry for leaving this open forever

@MatthewDKLe could you please give this a check if you have time?

caslam commented 1 year ago

YAY thank you guys!