Reviewing Markdown
February 11th, 2008
I was talking to my software engineering class about code reviews last week, while simultaneously thinking about how to replace the wiki parser in DrProject. Two birds one stone, I decided to review a wiki parser written in Python and keep notes on what I was thinking as I went through it. I’ve posted the result as a separate page on this web site; I’d be interested in comments and feedback.
Later: Diomidis Spinellis posted a similar think-aloud back in 2004 that’s worth reading.
This was a very interesting read. I wish I were taking your class as I feel I’d learn a lot (being just a hobbyist).
When I read your comments about unneeded modules (random and os, if I recall correctly) I thought to myself: why not use a tool like pylint to check the code? I think that the information given could be used as a complement (and sometimes confirmation) to the information gleaned from the code review.
As one of the Markdown developers, I have posted my response here: http://achinghead.com/archive/80/reviewing-markdown-response/
Greg, thanks for the feedback. I hope this answers your questions.