Skip to content

Commit bc92f3b

Browse files
committed
Explain WHY someone would want to have their code be Python 2/3 compatible
1 parent 6680729 commit bc92f3b

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

README.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ Modernize is a Python program that reads Python 2 source code
2323
and applies a series of fixers to transform it into source code
2424
that is valid on both Python 3 and Python 2.7.
2525

26-
This library is a very thin wrapper around `fissix
27-
<https://github.com/jreese/fissix>`_, a fork of lib2to3.
26+
This allows you to run your test suite on Python 2.7 and Python 3
27+
so you can gradually port your code to being fully Python 3
28+
compatible without slowing down development of your Python 2
29+
project.
2830

2931
The ``python -m modernize`` command works like
3032
``python -m fissix``, see `fissix <https://github.com/jreese/fissix>`_.
@@ -45,3 +47,6 @@ Python 2.5 or lower.
4547

4648
See the ``LICENSE`` file for the license of ``modernize``.
4749
Using this tool does not affect licensing of the modernized code.
50+
51+
This library is a very thin wrapper around `fissix
52+
<https://github.com/jreese/fissix>`_, a fork of lib2to3.

docs/index.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@ Modernize
1212
Purpose of the project
1313
======================
1414

15-
.. TODO Explain WHY someone would want to have their code be Python 2/3 compatible
1615
Modernize is a Python program that reads Python 2 source code
1716
and applies a series of fixers to transform it into source code
1817
that is valid on both Python 3 and Python 2.7.
1918

20-
This library is a very thin wrapper around `fissix
21-
<https://github.com/jreese/fissix>`_, a fork of lib2to3.
19+
This allows you to run your test suite on Python 2.7 and Python 3
20+
so you can gradually port your code to being fully Python 3
21+
compatible without slowing down development of your Python 2
22+
project.
2223

2324
The ``python -m modernize`` command works like
2425
``python -m fissix``, see `fissix <https://github.com/jreese/fissix>`_.
@@ -37,6 +38,9 @@ Python 2.5 or lower.
3738
See the ``LICENSE`` file for the license of ``modernize``.
3839
Using this tool does not affect licensing of the modernized code.
3940

41+
This library is a very thin wrapper around `fissix
42+
<https://github.com/jreese/fissix>`_, a fork of lib2to3.
43+
4044
The `project website`_ can be found on GitHub and the PyPI project name is
4145
modernize_
4246

0 commit comments

Comments
 (0)