Anonymous avatar Anonymous committed 2c00115

adding the list of supported args for DefaultWildcard to pydoc

Comments (0)

Files changed (2)

rope/refactor/restructure.py

     `args` is a dictionary of wildcard names to wildcard arguments.
     If the argument is a tuple, the first item of the tuple is
     considered to be the name of the wildcard to use; otherwise the
-    "default" wildcard is used.
+    "default" wildcard is used.  For getting the list arguments a
+    wildcard supports, see the pydoc of the wildcard.  (see
+    `rope.refactor.wildcard.DefaultWildcard` for the default
+    wildcard.)
 
     `wildcards` is the list of wildcard types that can appear in
     `pattern`.  See `rope.refactor.wildcards`.  If a wildcard does not

rope/refactor/wildcards.py

 
 
 class DefaultWildcard(object):
+    """The default restructuring wildcard
+
+    The argument passed to this wildcard is in the
+    ``key1=value1,key2=value2,...`` format.  Possible keys are:
+
+    * name - for checking the reference
+    * type - for checking the type
+    * object - for checking the object
+    * instance - for checking types but similar to builtin isinstance
+    * exact - matching only occurrences with the same name as the wildcard
+
+    """
 
     def __init__(self, project):
         self.project = project
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.