rename example project folder names to match java but hyphenated #95
Conversation
There was a problem hiding this comment.
If we were to do this, there are a bunch of links to examples in frc-docs that also need to be updated.
... if others support support this renaming, then this is fine, but I don't feel strongly about it. Probably now is as good a time as any to make the change.
arm-bot-offboard/constants.py
Outdated
There was a problem hiding this comment.
Other *bot examples are already hyphenated (hatch-bot, mecanum-bot, differential-drive-bot). Figured I'd keep that pattern consistent.
There was a problem hiding this comment.
I think we should be consistent with the C++ names: https://github.com/wpilibsuite/allwpilib/tree/main/wpilibcExamples/src/main/cpp/examples/ArmBotOffboard
There was a problem hiding this comment.
I have to disagree. Everything else about these is following the java examples.
There was a problem hiding this comment.
WTF, why are the Java and C++ examples named differently?
There was a problem hiding this comment.
Oh, because of the directory is part of the package name, and java package names are always all lowercase.
... yeah, we probably should follow the C++ conventions for example naming, and Java for the actual example content, it'll be a lot easier to read. But we already merged this. Lame.
There was a problem hiding this comment.
Ah fair point. Okay, I'll get that changed and open yet another PR (you must hate seeing my name pop up by now). Probably later tonight
Perfectly fair. My OCD-tendencies like consistency, but it really wasn't much work at all so either way. I was tempted to go the other way and remove the hyphens entirely, but I'd actually rather change the java side to match this if to be honest. I find this to be a bit more readable since we're keeping everything lowercase. |
|
My opinion would be to either match the Java examples exactly or just leave it and be "better" in the future. |
fletch3555
force-pushed
the
rename-examples-for-consistency
branch
from
4613ec4 to
715b524
Compare
I'm inclined to agree. The idea didn't come to me until I was committing these changes. I've now updated them to remove the hyphens. I still need to take a closer look to confirm they're all correct, but this should at least be 99% of it |
I figured since we're going for parity, we might as well have consistency.
If we want full parity, I'm happy to switch this to no hyphens instead just like the java examples.
Thoughts?