launchpad-reviewers team mailing list archive

["Jeroen T. Vermeulen" <jtv@xxxxxxxxxxxxx>]

Jeroen T. Vermeulen has proposed merging lp:~jtv/maas/xxx-todo into lp:maas.

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~jtv/maas/xxx-todo/+merge/115876

Julian suggested this in a review: I had used XXX markers in templates/management_command.py so as not to produce spurious output for the bzr command that lists TODO tags.  But apparently that tool only looks at modified files, so having TODO markers in the templates is just right.

I also sprinkled a few more in other templates.
-- 
https://code.launchpad.net/~jtv/maas/xxx-todo/+merge/115876
Your team Launchpad code reviewers is requested to review the proposed merge of lp:~jtv/maas/xxx-todo into lp:maas.

=== modified file 'templates/management_command.py'
--- templates/management_command.py	2012-07-18 05:55:00 +0000
+++ templates/management_command.py	2012-07-20 02:40:27 +0000
@@ -1,7 +1,7 @@
 # Copyright 2012 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
-# XXX: Document purpose.
+# TODO: Document purpose.
 """Django command: """
 
 from __future__ import (
@@ -23,15 +23,15 @@
 class Command(BaseCommand):
 
     option_list = BaseCommand.option_list + (
-        # XXX: Define actual options.
+        # TODO: Define actual options.
         make_option(
             '--option', dest='option', default=None,
             help="Describe option."),
       )
-    # XXX: Describe the command.
+    # TODO: Describe the command.
     help = "Purpose of this command."
 
     def handle(self, *args, **options):
-        # XXX: Replace the lines below with your actual code.
+        # TODO: Replace the lines below with your actual code.
         option = options.get('option', None)
         print(option)

=== modified file 'templates/module.py'
--- templates/module.py	2012-04-16 10:00:51 +0000
+++ templates/module.py	2012-07-20 02:40:27 +0000
@@ -1,6 +1,7 @@
 # Copyright 2012 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
+# TODO: Description here.
 """..."""
 
 from __future__ import (

=== modified file 'templates/test_module.py'
--- templates/test_module.py	2012-06-15 07:20:29 +0000
+++ templates/test_module.py	2012-07-20 02:40:27 +0000
@@ -1,6 +1,7 @@
 # Copyright 2012 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
+# TODO: Description here.
 """..."""
 
 from __future__ import (
@@ -16,6 +17,7 @@
 
 
 class TestSomething(TestCase):
+# TODO: Change test class name to match what you're testing.
 
     #resources = [...]