Skip to content

Commit e72a3d0

Browse files
committed
More doc updates
1 parent 42f89d1 commit e72a3d0

4 files changed

Lines changed: 23 additions & 134 deletions

File tree

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Features
3232
- ``past.translation`` package supports transparent translation of Python 2
3333
modules to Python 3 upon import. [This feature is currently in alpha.]
3434

35-
- 330+ unit tests
35+
- 470+ unit tests
3636

3737
- ``futurize`` and ``pasteurize`` scripts based on ``2to3`` and parts of
3838
``3to2`` and ``python-modernize``, for automatic conversion from either Py2
@@ -139,9 +139,9 @@ the block::
139139
Automatic translation
140140
---------------------
141141

142-
The ``past`` package can now automatically and transparently translate some
143-
Python 2 modules to Python 3 upon import. For example, here is how to use a
144-
Python 2-only package called ``plotrique`` on Python 3. First install it::
142+
The ``past`` package can now automatically translate some simple Python 2
143+
modules to Python 3 upon import. For example, here is how to use a Python 2-only
144+
package called ``plotrique`` on Python 3. First install it::
145145

146146
$ pip3 install plotrique==0.2.5-7 --no-compile # to ignore SyntaxErrors
147147

docs/faq.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,10 @@ Is it tested?
119119
-------------
120120

121121
``future`` is used by ``mezzanine``, among other projects. Currently
122-
``future`` has 330+ unit tests. In general, the ``future`` package
123-
itself is in good shape, whereas the ``futurize`` script for automatic
124-
porting is incomplete and imperfect. (Chances are it will require some
125-
manual cleanup afterwards.)
122+
``future`` has 470+ unit tests. Many of these are straight from the Python 3.3
123+
test suite. In general, the ``future`` package itself is in good shape, whereas
124+
the ``futurize`` script for automatic porting is incomplete and imperfect.
125+
(Chances are it will require some manual cleanup afterwards.)
126126

127127
Is the API stable?
128128
------------------

docs/overview_new.rst

Lines changed: 0 additions & 122 deletions
This file was deleted.

docs/translation.rst

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,21 @@ This is a standard Python 3 data type, so, when called from Python 3 code,
8888
Known limitations of ``past.translation``
8989
*******************************************
9090

91-
- The source translation feature offered by the ``past.translation``
92-
package has some of the same limitations as the ``futurize`` script (see
93-
:ref:`futurize-limitations`). Help developing and testing this feature further
94-
would be particularly welcome.
91+
- This only works with pure-Python modules. C extension modules and Cython code
92+
are not supported.
93+
94+
- The biggest hurdle to automatic translation is likely to be ambiguity
95+
about byte-strings and text (unicode strings) in the Python 2 code. If the
96+
``past.autotranslate`` feature fails because of this, you could try
97+
running ``futurize`` over the code and adding a ``b''`` or ``u''`` prefix to
98+
the relevant string literals. To convert between byte-strings and text (unicode
99+
strings), add an ``.encode`` or ``.decode`` method call. If this succeeds,
100+
please push your patches upstream to the package maintainers.
101+
102+
- Otherwise, the source translation feature offered by the ``past.translation``
103+
package has similar limitations to the ``futurize`` script (see
104+
:ref:`futurize-limitations`). Help developing and testing this feature further
105+
would be particularly welcome.
95106

96107
Please report any bugs you find on the ``python-future`` `bug tracker
97108
<https://github.com/PythonCharmers/python-future/>`_.

0 commit comments

Comments
 (0)