Skip to content

Commit

Permalink
Merge Typos and some wording suggestions (torsava/pr1)
Browse files Browse the repository at this point in the history
  • Loading branch information
encukou committed Apr 4, 2016
2 parents 0d6fb31 + f871ed9 commit 01ac81f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ The Conservative Python 3 Porting Guide
This guide is in *outline* stage. The details are not fleshed out.

This document will guide you through porting your software to Python 3.
It is geared towards projects that are ported because support for Python 2
is ending in a few years, and less for those where that are porting because
It is geared towards projects that are being ported because support for
Python 2 is ending in a few years, and less for those that are porting because
Python 3 as a language allows writing expressive, maintainable and correct
code more easily.
It mainly targets projects with large, conservative codebases.
Expand Down
14 changes: 7 additions & 7 deletions source/process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ up their interfaces.
For any libraries that are ported already, look in their documentation for
any notes specific to Python 3, and if you find any, note them for later.

If you depend on a library that is not ported, inquire its authors about
If you depend on a library that is not ported, inquire of its authors about
the porting status.
If the library is open-source, consider helping to port it – the experience
will likely help in your own project.
Expand All @@ -33,8 +33,8 @@ for dropped packages.
Run the Tests
.............

It's not practical to make any changes to untested code, let alone porting
to an updated language.
It's impractical to make any changes to untested code, let alone porting
the entire codebase to a new version of the programming language.

If the project has automatic tests, run them under Python 2 to make sure
they pass.
Expand Down Expand Up @@ -88,7 +88,7 @@ you do only one type of change per commit/patch.
For example, one patch to change the :ref:`except syntax <except-syntax>`,
then another for the :ref:`raise syntax <raise-syntax>`.
Do not submit a single patch saying “Port to Python 3”.
Doing this makes the change much easier to review.
Following this workflow makes the changes much easier to review.

The descriptions of individual items in this guide are written so that you
can use them in commit messages with minimal changes to explain why each change
Expand All @@ -102,10 +102,10 @@ The next chapter, :doc:`tools`, explains how to automate porting and checking.

Each of the subsequent chapters explains one area where Python 3 differs from
Python 2, and how to adapt the code.
They are arranged roughly in the typical order they are tackled in a typical
project.
The chapters are arranged roughly according to the order in which they are
tacked in a typical project.

We recommend that you skim the introduction of each of the chapters,
so that you know what you're up against pefore you start.
so that you know what you're up against before you start.

Happy porting!

0 comments on commit 01ac81f

Please sign in to comment.