Ali Gholami Rudi  committed 728d7db

documenting changes for the new release

  • Participants
  • Parent commits 7c661bb

Comments (0)

Files changed (1)

 New Features
+* Checking isinstance in restructurings
+* Better handling of one-liners
+* Choosing which files to apply a restructuring on
+* Allowing customizable restructuring wild-cards
+Restructuring ``checks`` has been deprecated in favor of restructuring
+``arguments``.  This change is the first step towards custom
+wild-cards.  So if you used::
+  strchecks = {'obj1.type': 'mod.A', 'obj2': 'mod.B',
+               'obj3.object': 'mod.C'}
+  checks = restructuring.make_checks(strchecks)
+you should use::
+  args = {'obj1': 'type=mod.A', 'obj2': 'name=mod.B',
+          'obj3': 'object=mod.C'}
+where obj1, obj2 and obj3 are wildcard names that appear in
+restructuring pattern.  And `args` is passed to the constructor.
+Also wild-card names starting with ``?`` used to match any expression
+that appeared at that point.  From now on, all wild-cards do so by
+default; if you want to match a name with the same name as wild-card
+name, you can use the ``exact`` argument of the default wild-card.
+Like ``pow: object:mod.A,exact``.
+A new argument has been added to the default wild-cards that acts very
+similar to ``isinstance`` built-in function.  ``obj: instance=mod.A``
+means either `obj` is an instance of `mod.A` or it is an instance of a
+subclass of it.
+A new parameter called ``resources`` is added to
+`Restructure.get_changes()`.  It can be used to limit the list of
+resources to apply a restructuring on; restructurings are applied on
+all python files in the project, by default.
 Getting Started
 * List of features: `docs/rope.txt`_
+* Overview of some of rope's features: `docs/overview.txt`_
 * Using as a library: `docs/library.txt`_
 * Contributing: `docs/contributing.txt`_
 .. _`docs/rope.txt`: docs/rope.html
+.. _`docs/rope.txt`: docs/overview.html
 .. _`docs/contributing.txt`: docs/contributing.html
 .. _`docs/library.txt`: docs/library.html