I left a comment (and the "original" line) in the source because I was to mention it on the mailing list (which I did), in the hopes that it would be easier for people who come and check to see *what* I've done in a glimpse, and can revert it easily if the change was complete nonsense.
Magnus
Timwi wrote:
Magnus Manske wrote:
# Run full parser on the included text! $text = $this->internalParse( $text, $newline, $assocArgs ); ! # I replaced the line below with the line above, as it former seems to cause several bugs ! #$text = $this->stripParse( $text, $newline, $assocArgs );
What is the general opinion on the usefulness of such comments? In my mind, it would seem that having CVS archive the old versions is sufficient to document any change. Personally, I object to leaving commented-out code in the files. (But then again, maybe I'm just copying this tradition from LiveJournal.)
Of course, it would also be helpful if the commit message explained why this change actually fixes the bug. I understand that you may not know; you may have just experimented and found that this change happens to fix one or more bugs. But I'm pretty sure that any information you can supply about the effects of this change on the bug in question will be helpful to other developers (especially people like myself who don't know the code very well yet).
Timwi
Wikitech-l mailing list Wikitech-l@wikimedia.org http://mail.wikipedia.org/mailman/listinfo/wikitech-l