Anonymous avatar Anonymous committed 52204e1

fixmodnames: added docs

Comments (0)

Files changed (1)

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:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.