Dear fellow Engineers,
Hi. How you doing? All comfy? Good.
Hey, i wanted to talk to you about something that you do. It's kinda related to versioning.
You see, i've seen a bunch of different versions of this, but it all follows the same pattern:
function foo (int bar); // This function is deprecated.
i mean, i'm perfectly fine with taking functions out of use. It happens. you figure out some improvement, or realize a bug, or sober up, or something and suddenly that foo function isn't really the best idea it once was. Good. Deprecate it. Hey, you even marked it in the code so that others would know not to use it either.
Could you do the next step, though and, you know, FREAKING POINT TO WHAT FUNCTION i SHOULD USE!?
Hell, i don't care if the next version is also deprecated because that should point to whatever i should be using. Simply marking something "Hey, don't use this anymore" is a bit like saying "Don't press the shiny, red, candy-like button".
Don't do it for yourself. Do it for folks like me who may not be 100% familiar with your code base.
Mostly because we're running out of things to call you and we're starting to repeat ourselves.
Save This Page
