search

project-open-data / csv-to-api

Proof of concept to dynamically generate RESTful APIs from static CSVs
http://labs.data.gov/csv-to-api/
326 stars 81 forks source link

A few beginning comments and details #1

Closed waldoj closed 12 years ago

waldoj commented 12 years ago

Some baby steps towards commenting this in sufficient detail that somebody who doesn't know PHP can understand it and replicate it, along with a demystifying description of the program's reliance on WordPress.

benbalter commented 12 years ago

Holy wow this is awesome. For the record, I do want to point out, that I normally comment quite religiously. See generally https://github.com/benbalter/WP-Document-Revisions/blob/master/wp-document-revisions.php :)

waldoj commented 12 years ago

I think this approach actually works better, though. By not commenting this, I'm forced to figure it out, which requires that I read your code more critically. And then by reading my comments, you can verify that they're correct. The result should be better code and better commenting. Think of it as asynchronous pair programming. :)