Add documentation to MoveGlobal.get_changes()

python-rope · Dec 22, 2022 · 211a005 · 211a005
1 parent 34c1ff4
commit 211a005
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/rope/refactor/move.py b/rope/refactor/move.py
@@ -318,6 +318,16 @@ def get_changes(
         resources=None,
         task_handle=taskhandle.NullTaskHandle(),
     ):
+        """Return the changes needed for this refactoring
+
+        Parameters:
+
+        - `dest`: the Resource or dotted moddule name of the move destination
+        - `resources` can be a list of `rope.base.resources.File` to
+          apply this refactoring on.  If `None`, the restructuring
+          will be applied to all python files.
+
+        """
         if isinstance(dest, str):
             dest = self.project.find_module(dest)
         if resources is None: