Added a comment about name argument

ros · Apr 2, 2015 · 4b781b7 · 4b781b7
1 parent df9096a
commit 4b781b7
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/dynamic_reconfigure/parameter_generator_catkin.py b/src/dynamic_reconfigure/parameter_generator_catkin.py
@@ -295,6 +295,10 @@ def mkdirabs(self, path):
                     raise
 
     def generate(self, pkgname, nodename, name):
+        """
+        name must match the first part of the configuration file.
+        e.g. given Tutorials.cfg, name must be Tutorials
+        """
         try:
             if sys.modules['__main__']._DYNAMIC_RECONFIGURE_GENERATING_DEPENDENCIES:
                 # Done this way because importing this module from gendeps