Source changes should include date of change

Neia Neutuladh neia at ikeran.org
Sat Sep 8 18:47:39 UTC 2018


On Saturday, 8 September 2018 at 06:59:28 UTC, Josphe Brigmo 
wrote:
> Having source code that doesn't show changes with dates is 
> pretty useless for diagnostics. I realize that git has the 
> changes but the source code should.

What problem did you encounter where you had trouble getting the 
information you needed with git blame, where a source code 
comment listing change dates would help?

> Why not also add a link to the git hub patch

Because that's a lot of work to replicate something git already 
does.

> or bugzilla or whatever?

Currently, some code in phobos does reference issues on the dlang 
bugzilla. The common categories for this include:

* Explaining why we want things to work this way, if that 
requires more than a couple sentences of explanation
* Pointing out what problem this is a workaround for
* Pointing out which past problem motivated this unittest

Things that help you understand the code as it currently is.

Is there some situation you've encountered in the past where that 
kind of comment wasn't enough?


More information about the Digitalmars-d mailing list