Open Quincunx271 opened 2 years ago
I think Visual Studio allows for automated renaming (F2 on a symbol) -- this may only be with C/C++ (Microsoft) extension. I haven't tried this feature, so I can't speak on its reliability, however it could be useful here.
As a side note, earlier I defended the weird vowel-removed naming scheme, however I have grown to dislike it -- I agree with renaming.
If the F2 rename works (if it compiles afterwards), then that's probably the easiest technique.
Actually, a better idea might be to have two versions of the function for some period of time (e.g. two months) to enable people to merge the changes into their branch. That is, keep the old function name around as an alias for the new name so that the migration can be done non-atomically.
For example:
// Before:
void UpdtRdyLst_(...) {
// The code
}
// After, pretending this change happened 2021-11-07:
void updateReadyList_(...) {
// The code
}
[[deprecated("Renamed to updateReadyList_. Will be removed after 2022-01-07")]]
void UpdtRdyLst_(...) {
updateReadyList_(...);
}
This action could be used to schedule the function deletion by creating a branch with the deletion and PR-ing it with a scheduled merge: https://github.com/marketplace/actions/merge-schedule.
Breaking off from #47. There are two ideas at play here:
We have a lot of shortened names which are hard to read:
Many of our names break the clang-tidy check set up by LLVM:
This is not an issue that can be fixed in one PR. It must be split into many. This is also significantly easier if we practice short branches rather than long-lived feature branches, else merge conflicts will be rampant and hard to fix.
Some advice on tackling this: