Commits

Anonymous committed 52204e1

fixmodnames: added docs

  • Participants
  • Parent commits 428849c

Comments (0)

Files changed (1)

File rope/contrib/fixmodnames.py

+"""Fix the name of modules"""
 from rope.base import change, taskhandle
 from rope.contrib import changestack
 from rope.refactor import rename
 
     def get_changes(self, fixer=str.lower,
                     task_handle=taskhandle.NullTaskHandle()):
+        """Fix module names
+
+        `fixer` is a function that takes and returns a `str`.  Given
+        the name of a module, it should return the fixed name.
+
+        """
         stack = changestack.ChangeStack(self.project, 'Fixing module names')
         try:
             while True: