Commits

Anonymous committed af64e98

Added docs for batchset dialog command

Comments (0)

Files changed (1)

 applies the first completion without asking.
 
 
+Dialog batchset command
+-----------------------
 
-Keybinding
-----------
+When you use rope dialogs there is a command called ``batchset``.  It
+can be used to set many configs at the same time.  After selecting
+this command from dialog base prompt, you are asked to enter a string.
+
+Batch-set strings can give value to configs in two ways.  The single
+line form is like this::
+
+  name1 value1
+  name2 value2
+
+That is the name of config is followed its value.  For multi-line
+values you can use::
+
+  name1
+   line1
+   line2
+
+  name2
+   line3
+
+Each line of the definition should start with a space or a tab.  Note
+that blank lines before the name of config definitions are ignored.
+
+``batchset`` command is useful when performing refactorings with long
+configs, like restructurings::
+
+  pattern ${?pycore}.create_module(${?project}.root, ${?name})
+
+  goal generate.create_module(${?project}, ${?name})
+
+  imports
+   from rope.contrib import generate
+
+  checks
+   ?pycore.type == rope.base.pycore.PyCore
+   ?project.type == rope.base.project.Project
+
+Now this string can be used for ``batchset`` string in restructuring
+dialog.
+
+
+Key-binding
+-----------
 
 Uses almost the same keybinding as ropeide.
 
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.