Skip to content

Commit 0eaa59d

Browse files
committed
Tweak docs
1 parent 3c01d8b commit 0eaa59d

File tree

4 files changed

+23
-21
lines changed

4 files changed

+23
-21
lines changed

README.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
.. _overview:
22

3-
Overview: an easier, safer, cleaner upgrade path to Python 3
4-
============================================================
3+
Overview: Easy, clean, reliable Python 2/3 compatibility
4+
========================================================
55

6-
7-
``python-future`` is the missing compatibility layer between Python 3 and
8-
Python 2. It allows you to maintain a single, clean Python 3.x-compatible
9-
codebase with minimal cruft and run it easily on Python 2 mostly unchanged.
6+
``python-future`` is the missing compatibility layer between Python 2 and
7+
Python 3. It allows you to use a single, clean Python 3.x-compatible
8+
codebase to support both Python 2 and Python 3 with minimal overhead.
109

1110
It provides ``future`` and ``past`` packages with backports and forward ports of
1211
features from Python 3 and 2. It also comes with ``futurize`` and
1312
``pasteurize``, customized 2to3-based scripts that helps you to convert either
1413
Py2 or Py3 code easily to support both Python 2 and 3 in a single clean
1514
Py3-style codebase, module by module.
1615

17-
Notable projects that use ``future`` for Python 3/2 compatibility are `Mezzanine
18-
<http://mezzanine.jupo.org/>`_ and `ObsPy <http://obspy.org>`_.
16+
Notable projects that use ``python-future`` for Python 3/2 compatibility
17+
are `Mezzanine <http://mezzanine.jupo.org/>`_ and `ObsPy
18+
<http://obspy.org>`_.
1919

2020
.. _features:
2121

@@ -254,14 +254,15 @@ Licensing
254254
---------
255255
256256
:Author: Ed Schofield
257+
258+
:Copyright: 2013-2014 Python Charmers Pty Ltd, Australia.
259+
257260
:Sponsor: Python Charmers Pty Ltd, Australia, and Python Charmers Pte
258261
Ltd, Singapore. http://pythoncharmers.com
259-
:Others: See `Credits <http://python-future.org/credits.html>`_.
260262
261-
Copyright 2013-2014 Python Charmers Pty Ltd, Australia.
263+
:Licence: MIT. See ``LICENSE.txt`` or `here <http://python-future.org/credits.html>`_.
262264
263-
The software is distributed under an MIT licence. See ``LICENSE.txt`` or `Licensing
264-
<http://python-future.org/licensing.html>`_.
265+
:Other credits: See `here <http://python-future.org/credits.html>`_.
265266
266267
267268
Next steps

docs/_templates/sidebarintro.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!--<h3>Python-Future</h3>
22
<p>-->
3-
<h4>An easier, safer, cleaner upgrade path to Python 3.</h4>
3+
<h4>Easy, clean, reliable Python 2/3 compatibility</h4>
44
<!--
55
</p>
66
<h3>Other Formats</h3>
@@ -14,6 +14,6 @@ <h3>Other Formats</h3>
1414
-->
1515
<!--<h3>Useful Links</h3>-->
1616
<ul>
17-
<li><a href="http://pypi.python.org/pypi/future">future @ PyPI</a></li>
18-
<li><a href="https://github.com/PythonCharmers/python-future">future @ github</a></li>
17+
<li><a href="http://pypi.python.org/pypi/future">on PyPI</a></li>
18+
<li><a href="https://github.com/PythonCharmers/python-future">on GitHub</a></li>
1919
</ul>

docs/faq.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,9 @@ What is the relationship between ``future`` and ``six``?
207207
--------------------------------------------------------
208208

209209
``python-future`` is a higher-level compatibility layer than ``six`` that
210-
includes more backported functionality from Python 3 and supports cleaner
211-
code but requires more modern Python versions to run.
210+
includes more backported functionality from Python 3, more forward-ported
211+
functionality from Python 2, and supports cleaner code, but requires more
212+
modern Python versions to run.
212213

213214
``python-future`` and ``six`` share the same goal of making it possible to write
214215
a single-source codebase that works on both Python 2 and Python 3.

docs/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
future: clean single-source support for Python 2/3
2-
======================================================
1+
Easy, clean, reliable Python 2/3 compatibility
2+
==============================================
33

4-
``future`` is the missing compatibility layer between Python 2 and Python
5-
3. It allows you to use a single, clean Python 3.x-compatible
4+
``python-future`` is the missing compatibility layer between Python 2 and
5+
Python 3. It allows you to use a single, clean Python 3.x-compatible
66
codebase to support both Python 2 and Python 3 with minimal overhead.
77

88

0 commit comments

Comments
 (0)