summaryrefslogtreecommitdiff
path: root/docs/python3.rst
diff options
context:
space:
mode:
authorKevin Yap <me@kevinyap.ca>2014-06-05 19:23:05 -0700
committerKevin Yap <me@kevinyap.ca>2014-06-05 19:23:05 -0700
commit10977b925e67c48261bfd6eaf71e7ba6a3bb7374 (patch)
tree4e52a49b221b42dcf56a99385c0e6608659b506f /docs/python3.rst
parent39b89928ea93872f781ff19259239ffc4b0a63f2 (diff)
downloadclick-10977b925e67c48261bfd6eaf71e7ba6a3bb7374.tar.gz
Minor documentation fixes
Diffstat (limited to 'docs/python3.rst')
-rw-r--r--docs/python3.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/python3.rst b/docs/python3.rst
index afe0f91..73958a4 100644
--- a/docs/python3.rst
+++ b/docs/python3.rst
@@ -3,12 +3,12 @@ Python 3 Support
.. currentmodule:: click
-Click supports Python 3 but like all other command line utility libraries,
+Click supports Python 3, but like all other command line utility libraries,
it suffers from the Unicode text model in Python 3. All examples in the
-documentation were written so that they run on both Python 2.x and
+documentation were written so that they could run on both Python 2.x and
Python 3.3 or higher.
-At the moment the strong recommendation is to use Python 2 for these
+At the moment, it is strongly recommended is to use Python 2 for click
utilities unless Python 3 is a hard requirement.
.. _python3-limitations:
@@ -58,7 +58,7 @@ Python 2 and 3 Differences
Click attempts to minimize the differences between Python 2 and Python 3
by following the best practices for both languages.
-in Python 2, the following is true:
+In Python 2, the following is true:
* ``sys.stdin``, ``sys.stdout``, and ``sys.stderr`` are opened in binary
mode, but under some circumstances they support Unicode output. Click
@@ -72,7 +72,7 @@ in Python 2, the following is true:
and will instead use the operating system's byte APIs to open the
files.
-in Python 3, the following is true:
+In Python 3, the following is true:
* ``sys.stdin``, ``sys.stdout`` and ``sys.stderr`` are by default
text-based. When click needs a binary stream, it attempts to discover
@@ -127,20 +127,20 @@ You are dealing with an environment where Python 3 thinks you are
restricted to ASCII data. The solution to these problems is different
depending on which locale your computer is running in.
-For instance if you have a German Linux machine you can fix the problem
+For instance, if you have a German Linux machine, you can fix the problem
by exporting the locale to ``de_DE.utf-8``::
export LC_ALL=de_DE.utf-8
export LANG=de_DE.utf-8
If you are on a US machine, ``en_EN.utf-8`` is the encoding of choice. On
-some newer Linux systems you can also try ``C.UTF-8`` as locale::
+some newer Linux systems, you could also try ``C.UTF-8`` as the locale::
export LC_ALL=C.UTF-8
export LANG=C.UTF-8
You need to do this before you invoke your Python script. If you are
-curious about the reasons for this you can join the discussions in the
+curious about the reasons for this, you can join the discussions in the
Python 3 bug tracker:
* `ASCII is a bad filesystem default encoding