aboutsummaryrefslogtreecommitdiffstats
path: root/mediagoblin
diff options
context:
space:
mode:
authorElrond <elrond+mediagoblin.org@samba-tng.org>2013-01-26 00:10:30 +0100
committerElrond <elrond+mediagoblin.org@samba-tng.org>2013-04-06 16:53:04 +0200
commit441238539485dcf0b5fd612e8f795a7bfb233727 (patch)
treeaeb37c39761067e1659be84e97a71ed6d1a0dec7 /mediagoblin
parent455fd36ff66746aecd66095080ae00a547337a8c (diff)
downloadmediagoblin-441238539485dcf0b5fd612e8f795a7bfb233727.tar.lz
mediagoblin-441238539485dcf0b5fd612e8f795a7bfb233727.tar.xz
mediagoblin-441238539485dcf0b5fd612e8f795a7bfb233727.zip
Better docs for GenerateSlugMixin.
Diffstat (limited to 'mediagoblin')
-rw-r--r--mediagoblin/db/mixin.py10
1 files changed, 9 insertions, 1 deletions
diff --git a/mediagoblin/db/mixin.py b/mediagoblin/db/mixin.py
index f2c2932c..0dc3bc85 100644
--- a/mediagoblin/db/mixin.py
+++ b/mediagoblin/db/mixin.py
@@ -53,9 +53,17 @@ class UserMixin(object):
class GenerateSlugMixin(object):
+ """
+ Mixin to add a generate_slug method to objects.
+
+ Depends on:
+ - self.slug
+ - self.title
+ - self.check_slug_used(new_slug)
+ """
def generate_slug(self):
"""
- Generate a unique slug for this MediaEntry.
+ Generate a unique slug for this object.
This one does not *force* slugs, but usually it will probably result
in a niceish one.