From e83dc091cc8d60f5dd7372b0d684f16fbfbc7fec Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Sun, 17 Jul 2011 17:06:06 -0500 Subject: [PATCH] docstring for MediaComment's structure --- mediagoblin/db/models.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/mediagoblin/db/models.py b/mediagoblin/db/models.py index db755402..bad15aca 100644 --- a/mediagoblin/db/models.py +++ b/mediagoblin/db/models.py @@ -171,7 +171,6 @@ class MediaEntry(Document): viewing the work. (currently unused.) - thumbnail_file: Deprecated... we should remove this ;) - """ __collection__ = 'media_entries' @@ -294,6 +293,18 @@ class MediaEntry(Document): class MediaComment(Document): + """ + A comment on a MediaEntry. + + Structure: + - media_entry: The media entry this comment is attached to + - author: user who posted this comment + - created: when the comment was created + - content: plaintext (but markdown'able) version of the comment's content. + - content_html: the actual html-rendered version of the comment displayed. + Run through Markdown and the HTML cleaner. + """ + __collection__ = 'media_comments' structure = { -- 2.25.1