Skip to content

Commit ae19794

Browse files
committed
Update docs
1 parent cc18b94 commit ae19794

File tree

6 files changed

+14
-19
lines changed

6 files changed

+14
-19
lines changed

README.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ Features
5353
``past.utils`` selected from Py2/3 compatibility interfaces from projects
5454
like ``six``, ``IPython``, ``Jinja2``, ``Django``, and ``Pandas``.
5555

56-
- partial support for the ``surrogateescape`` error handler when encoding and
57-
decoding the backported ``str`` and ``bytes`` objects. (This is currently
58-
in alpha.)
56+
- support for the ``surrogateescape`` error handler when encoding and
57+
decoding the backported ``str`` and ``bytes`` objects. [This feature is
58+
currently in alpha.]
5959

6060
.. _code-examples:
6161

@@ -94,7 +94,7 @@ these imports as it does on Python 3.3+:
9494
# Extra arguments for the open() function
9595
f = open('japanese.txt', encoding='utf-8', errors='replace')
9696
97-
# New simpler super() function:
97+
# New zero-argument super() function:
9898
class VerboseList(list):
9999
def append(self, item):
100100
print('Adding an item')
@@ -155,9 +155,10 @@ interface works like this:
155155
# Then, for example:
156156
from itertools import filterfalse, zip_longest
157157
from urllib.request import urlopen
158-
from collections import Counter, OrderedDict, ChainMap # backported to Py2.6
158+
from collections import ChainMap
159159
from collections import UserDict, UserList, UserString
160160
from subprocess import getoutput, getstatusoutput
161+
from collections import Counter, OrderedDict # backported to Py2.6
161162
162163
163164
Automatic conversion to Py2/3-compatible code
@@ -190,7 +191,6 @@ For example, running ``futurize -w mymodule.py`` turns this Python 2 code:
190191
import Queue
191192
from urllib2 import urlopen
192193
193-
194194
def greet(name):
195195
print 'Hello',
196196
print name
@@ -210,7 +210,6 @@ into this code which runs on both Py2 and Py3:
210210
import queue
211211
from urllib.request import urlopen
212212
213-
214213
def greet(name):
215214
print('Hello', end=' ')
216215
print(name)
@@ -225,7 +224,7 @@ See :ref:`forwards-conversion` and :ref:`backwards-conversion` for more details.
225224
Automatic translation
226225
---------------------
227226

228-
The ``past`` package can now automatically translate some simple Python 2
227+
The ``past`` package can automatically translate some simple Python 2
229228
modules to Python 3 upon import. The goal is to support the "long tail" of
230229
real-world Python 2 modules (e.g. on PyPI) that have not been ported yet. For
231230
example, here is how to use a Python 2-only package called ``plotrique`` on
@@ -257,8 +256,8 @@ last resort; ideally Python 2-only dependencies should be ported
257256
properly to a Python 2/3 compatible codebase using a tool like
258257
``futurize`` and the changes should be pushed to the upstream project.
259258

260-
Note: the translation feature is still in alpha and needs more testing and
261-
development.
259+
Note: the auto-translation feature is still in alpha; it needs more testing and
260+
development, and will likely never be perfect.
262261

263262
For more info, see :ref:`translation`.
264263

docs/bytes_object.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,6 @@ code incompatibilities caused by the many differences between Py3 bytes
6666
and Py2 strings.
6767

6868

69-
surrogateescape
70-
~~~~~~~~~~~~~~~
71-
7269
The :class:`bytes` type from :mod:`builtins` also provides support for the
7370
``surrogateescape`` error handler on Python 2.x. Here is an example that works
7471
identically on Python 2.x and 3.x::

docs/credits.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ http://pythoncharmers.com
4141
Authors
4242
-------
4343

44-
Python-Future is written and maintained by Ed Schofield and various contributors:
44+
Python-Future is written and maintained by Ed Schofield with the help of
45+
various contributors:
4546

4647
Development Lead
4748
~~~~~~~~~~~~~~~~

docs/faq.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ How well has it been tested?
123123
currently being used to help with porting 800,000 lines of Python 2 code in
124124
`Sage <http://sagemath.org>`_ to Python 2/3.
125125

126-
Currently ``python-future`` has 920+ unit tests. Many of these are straight
127-
from the Python 3.3 test suite.
126+
Currently ``python-future`` has 990+ unit tests. Many of these are straight
127+
from the Python 3.3 and 3.4 test suites.
128128

129129
In general, the ``future`` package itself is in good shape, whereas the
130130
``futurize`` script for automatic porting is incomplete and imperfect.

docs/str_object.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,6 @@ same behaviours as Python 3's :class:`str`::
8484
>>> assert list(s) == ['A', 'B', 'C', 'D']
8585
>>> assert s.split('B') == ['A', 'CD']
8686

87-
surrogateescape
88-
~~~~~~~~~~~~~~~
8987

9088
The :class:`str` type from :mod:`builtins` also provides support for the
9189
``surrogateescape`` error handler on Python 2.x. Here is an example that works

docs/whatsnew.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ New features:
2323
- ``tkinter.ttk`` support (issue #151)
2424
- Backport of ``collections.ChainMap`` (issue #150)
2525
- Backport of ``itertools.count`` for Py2.6 (issue #152)
26+
- Enable and document support for the ``surrogateescape`` error handler for ``newstr`` and ``newbytes`` objects on Py2.x (issue #116). This feature is currently in alpha.
2627
- Add constants to ``http.client`` such as ``HTTP_PORT`` and ``BAD_REQUEST`` (issue #137)
2728
- Backport of ``reprlib.recursive_repr`` to Py2
28-
- Enable support for the ``surrogateescape`` error handler for ``newstr`` and ``newbytes`` objects on Py2.x (issue #116). This feature is currently in alpha.
2929

3030
Bug fixes:
3131

0 commit comments

Comments
 (0)