On Thu, Apr 23, 2020, at 5:38 PM, Aisha Tammy wrote: > > If you aren't already, you should be looking at commit messages from > > where the relevant code was touched. That is often where you'll find the > > explanations you seek. > > > I have been reading them, Commit messages don't explain algorithms very > clearly. > I agree this is a very specific use case but definitely something that > could be improved. > Some of the things I've been considering useful (in this specific > scenario for diff3) > - explanation for merge function, what it does > - in merge function, explain how empty for loop is used, as this is a > very big loop > with a lot of cases > > IMO, any function with a lot of cases should have a small explanation > about what it > is doing, so the code is a lot more lit. > > Cheers, > Aisha
I am no expert on reading code myself, but wouldn't be possible to look at who wrote that bit of code find their email address and ask them? There might not be a simple terse explanation that would go well in comments.
