[Python-checkins] r67437 - sandbox/trunk/2to3/README

[benjamin.peterson]

Author: benjamin.peterson
Date: Sat Nov 29 00:28:51 2008
New Revision: 67437

Log:
README updates

Modified:
   sandbox/trunk/2to3/README

Modified: sandbox/trunk/2to3/README
==============================================================================
--- sandbox/trunk/2to3/README	(original)
+++ sandbox/trunk/2to3/README	Sat Nov 29 00:28:51 2008
@@ -3,17 +3,17 @@
 
 A refactoring tool for converting Python 2.x code to 3.0.
 
-This is a work in progress! Bugs should be reported to
-http://bugs.python.org/ under the "2to3" category.
+This is a work in progress! Bugs should be reported to http://bugs.python.org/
+under the "2to3" category.
 
 
 General usage
 =============
 
-Run ``./2to3`` to convert stdin (``-``), files or directories given
-as arguments.  By default, the tool outputs a unified diff-formatted patch
-on standard output and a "what was changed" summary on standard error,
-but the ``-w`` option can be given to write back converted files, creating
+Run ``./2to3`` to convert stdin (``-``), files or directories given as
+arguments.  By default, the tool outputs a unified diff-formatted patch on
+standard output and a "what was changed" summary on standard error, but the
+``-w`` option can be given to write back converted files, creating
 ``.bak``-named backup files.
 
 2to3 must be run with at least Python 2.5. The intended path for migrating to
@@ -32,10 +32,10 @@
 lib2to3/pygram.py             - code specific to the Python grammar
 example.py                    - example input for play.py and fix_*.py
 find_pattern.py               - script to help determine the PATTERN for a new fix
-lib2to3/Grammar.txt           - Python grammar input (a copy of Python 2.5's Grammar/Grammar)
+lib2to3/Grammar.txt           - Python grammar input (accepts 2.x and 3.x syntax)
 lib2to3/Grammar.pickle        - pickled grammar tables (generated file, not in subversion)
 lib2to3/PatternGrammar.txt    - grammar for the pattern language used by patcomp.py
-lib2to3PatternGrammar.pickle  - pickled pattern grammar tables (generated file)
+lib2to3/PatternGrammar.pickle - pickled pattern grammar tables (generated file)
 lib2to3/pgen2/                - Parser generator and driver ([1]_, [2]_)
 lib2to3/fixes/                - Individual transformations
 lib2to3tests/                 - Test files for pytree, fixers, grammar, etc
@@ -217,8 +217,8 @@
 =====
 
 .. [#1] I modified tokenize.py to yield a NL pseudo-token for backslash
-        continuations, so the original source can be reproduced exactly.
-        The modified version can be found at pgen2/tokenize.py.
+        continuations, so the original source can be reproduced exactly.  The
+        modified version can be found at lib2to3/pgen2/tokenize.py.
 
 .. [#2] I developed pgen2 while I was at Elemental Security.  I modified
         it while at Google to suit the needs of this refactoring tool.
@@ -227,8 +227,8 @@
 Development
 ===========
 
-The HACKING file has a list of TODOs -- some simple, some complex -- that
-would make good introductions for anyone new to 2to3.
+The HACKING file has a list of TODOs -- some simple, some complex -- that would
+make good introductions for anyone new to 2to3.
 
 
 Licensing