This reads like a great code review comment, but it doesn't help explain the code that's left for future readers. Please remove the comment here. I do agree this is great information to put into the github pull request to aid people reviewing the code in understanding what you've changed and why.