Skip to content

Commit 2abb4bd

Browse files
committed
sync readme to docs/index.rst
1 parent cadb8cd commit 2abb4bd

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/index.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,26 @@ Purpose of the project
1313
======================
1414

1515
.. TODO Explain WHY someone would want to have their code be Python 2/3 compatible
16-
17-
This library is a very thin wrapper around ``fissix`` to utilize it
16+
This library is a very thin wrapper around `fissix
17+
<https://github.com/jreese/fissix>`_, a fork of lib2to3, to utilize it
1818
to make Python 2 code more modern with the intention of eventually
1919
porting it over to Python 3.
2020

21-
The ``python -m modernize`` command works like `fissix
22-
<https://github.com/jreese/fissix>`_. Here's how you'd rewrite a
21+
The ``python -m modernize`` command works like
22+
``python -m fissix``, see `fissix <https://github.com/jreese/fissix>`_.
23+
Here's how you'd rewrite a
2324
single file::
2425

2526
python -m modernize -w example.py
2627

27-
See the ``LICENSE`` file for the license of ``python -m modernize``.
28+
It does not guarantee, but it attempts to spit out a codebase compatible
29+
with Python 2.6+ or Python 3. The code that it generates has a runtime
30+
dependency on `six <https://pypi.python.org/pypi/six>`_, unless the
31+
``--no-six`` option is used. Version 1.9.0 or later of ``six`` is
32+
recommended. Some of the fixers output code that is not compatible with
33+
Python 2.5 or lower.
34+
35+
See the ``LICENSE`` file for the license of ``modernize``.
2836
Using this tool does not affect licensing of the modernized code.
2937

3038
The `project website`_ can be found on GitHub and the PyPI project name is

0 commit comments

Comments
 (0)