aboutsummaryrefslogtreecommitdiffstats
path: root/chapter08
diff options
context:
space:
mode:
authorDavid Bryant <davidbryant@gvtc.com>2022-12-08 15:13:28 -0600
committerDavid Bryant <davidbryant@gvtc.com>2022-12-08 15:13:28 -0600
commitd9883060de3a70a3468c2629b7853b2c54f59647 (patch)
tree4bbd4f342bd9e71089a2c7c28bfb2a07b5dfef36 /chapter08
parent8e751f73193e7d311a4790540b364e091ad973be (diff)
Capitalized references to the package. Clarified the descriptions of
pip3 -- the pip program processes both commands (e.g., install) and options (e.g., --no-index). Expressed option / command descriptions in the iindicative mood. The imperative mood should only be used to tell the reader what to do, not in explanatory verbiage. Inserted the definite article here and there. Corrected a misspelled instance of the indefinite article: we don't say "an utility" because the initial phoneme in "utility" is pronounced as YOO.
Diffstat (limited to 'chapter08')
-rw-r--r--chapter08/wheel.xml22
1 files changed, 11 insertions, 11 deletions
diff --git a/chapter08/wheel.xml b/chapter08/wheel.xml
index 5b09fc65b..7ab14426a 100644
--- a/chapter08/wheel.xml
+++ b/chapter08/wheel.xml
@@ -40,21 +40,21 @@
<sect2 role="installation">
<title>Installation of Wheel</title>
- <para>Compile wheel with the following command:</para>
+ <para>Compile Wheel with the following command:</para>
<screen><userinput remap="make">PYTHONPATH=src pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
- <para>Install wheel with the following command:</para>
+ <para>Install Wheel with the following command:</para>
<screen><userinput remap="install">pip3 install --no-index --find-links=dist wheel</userinput></screen>
<variablelist>
- <title>The meaning of the pip3 commands:</title>
+ <title>The meaning of the pip3 configuration options and commands:</title>
<varlistentry>
<term><envar>PYTHONPATH=src</envar></term>
<listitem>
- <para>Allow using this package (not installed yet) to build a
+ <para>Allows this package (not installed yet) to build a
wheel archive for itself, to avoid a chicken-or-egg problem.</para>
</listitem>
</varlistentry>
@@ -62,14 +62,14 @@
<varlistentry>
<term><command>wheel</command></term>
<listitem>
- <para>Build wheel archive for this package.</para>
+ <para>This command builds the wheel archive for this package.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>-w dist</parameter></term>
<listitem>
- <para>Put the created wheels into the
+ <para>Instructs pip to put the created wheel into the
<filename class='directory'>dist</filename> directory.</para>
</listitem>
</varlistentry>
@@ -77,7 +77,7 @@
<varlistentry>
<term><command>install</command></term>
<listitem>
- <para>Install the package.</para>
+ <para>This command installs the package.</para>
</listitem>
</varlistentry>
@@ -86,9 +86,9 @@
<parameter>--no-deps</parameter>, and
<parameter>--no-index</parameter></term>
<listitem>
- <para>Prevent pip from fetching files from the online package
+ <para>These options prevent fetching files from the online package
repository (PyPI). If packages are installed in the correct order,
- then it won't need to fetch any files in the first place, but these
+ pip won't need to fetch any files in the first place; these
options add some safety in case of user error.</para>
</listitem>
</varlistentry>
@@ -96,7 +96,7 @@
<varlistentry>
<term><parameter>--find-links dist</parameter></term>
<listitem>
- <para>Search wheel archives from the
+ <para>Instructs pip to search for wheel archives in the
<filename class='directory'>dist</filename> directory.</para>
</listitem>
</varlistentry>
@@ -128,7 +128,7 @@
<term><command>wheel</command></term>
<listitem>
<para>
- is an utility to unpack, pack, or convert wheel packages
+ is a utility to unpack, pack, or convert wheel packages
</para>
<indexterm zone="ch-system-wheel">
<primary sortas="b-wheel">wheel</primary>