Run pydoc on models.py, which will create models.html, that then documents the interfaces to your models.

plberg / cs373-idb

Project 3 (IDB) for CS 373: Software Engineering

0 stars 1 forks source link

Run pydoc on models.py, which will create models.html, that then documents the interfaces to your models. #4

Closed jabrouwer82 closed 9 years ago

jabrouwer82 commented 9 years ago

Create inline comments if you need to explain the why of a particular implementation. Use a consistent coding convention with good variable names, good indentation, blank lines, and blank spaces.

jabrouwer82 commented 9 years ago

I don't know that this will ever work.

jabrouwer82 commented 9 years ago

https://piazza.com/class/i563clif2i169a?cid=236

Downing recommended trying epydoc. This should be done asap so that we can report issues with it.

At the worst, we need lots more comments in our models and maybe that can qualify.