Database: should we adopt the "db_comment" field?
According to [1], there is a db_comment
field, that can be used to document the meaning of a DB field in the database itself. Seems sort of nice (especially as we don't have django + sphinx working yet).
[1] https://docs.djangoproject.com/en/5.0/ref/models/fields/#db-comment
Task: find a models.py
or a file inside models/*.py
and try to add a couple of these fields. Rubrics/models.py
might be a good place to start because there are at least docs for some of the fields.
This is definitely a case where every journey begins with a single step: no need to exhaustively document all fields, in fact its likely better not to, because some fields are not well understood and bad docs are worse than no docs.
Edited by Colin Macdonald