Add example to the lazy gettext version to make clear when it's appropriate

I needed an example to really get when lazy_gettext would be good...

diff --git a/mediagoblin/tools/translate.py b/mediagoblin/tools/translate.py
index eead6413154549284ec41ae1b2ac2c106bb2bf03..961445382e949b3469ea9b161b767be42d8d560f 100644 (file)
--- a/mediagoblin/tools/translate.py
+++ b/mediagoblin/tools/translate.py
@@ -129,7 +129,10 @@ def lazy_pass_to_ugettext(*args, **kwargs):
 
     This is useful if you have to define a translation on a module
     level but you need it to not translate until the time that it's
-    used as a string.
+    used as a string. For example, in:
+        def func(self, message=_('Hello boys and girls'))
+
+    you would want to use the lazy version for _.
     """
     return LazyProxy(pass_to_ugettext, *args, **kwargs)