-
Notifications
You must be signed in to change notification settings - Fork 12
Usage
Generally speaking, traad.el will try to be as invisible as possible. It will
try to start servers as they're necessary, only asking for user intervention
when it can't determine a project root. The default configuration values should
work well for most users.
To see traad.el in action, open a Python file and move your cursor to
something (a function name, variable name, whatever) that you want to rename and
run traad-rename:
M-x traad-rename
You'll be prompted for a new name, and after you enter it and press return, the
refactoring will be performed asynchronously. If you don't already have a
.ropeproject in a directory dominating your Python file, you'll be prompted
for the location of the project's root directory.
After some amount of time (which depends on how big your project is), traad
will finish the refactoring. Once the refactoring is done, traad.el will try
to refresh your buffers.
That's about it! There are plenty of other traad commands available. To explore
them you can browse traad.el or use describe-function to look at all of the
functions starting with traad-.
traad.el should not normally require much configuration. Here are the options
you might need to look at.
The traad-server-program variable is a string defining the executable to use
for the traad server. In some cases this can be left at the default value of
"traad", in which case the first "traad" found in you path will be used.
In many cases, though, you will more than one traad server installed. For
example, you may have traad installed for Python 2 and Python 3, or perhaps
you'll have traad installed in several virtual environments. To inform
traad.el which to use, you will need to change traad-server-program. This
variable is then used in traad-open to launch traad.
This is a list of other arguments to pass to the traad server. Typically you use this control the verbosity of the server.
The name of the virtual environment into which traad is installed.