Changeset d988306 for chapter08/wheel.xml

Timestamp:

12/08/2022 09:13:28 PM (17 months ago)

Author:

David Bryant <davidbryant@…>

Branches:

11.3, 11.3-rc1, 12.0, 12.0-rc1, 12.1, 12.1-rc1, bdubbs/gcc13, multilib, renodr/libudev-from-systemd, trunk, xry111/arm64, xry111/arm64-12.0, xry111/clfs-ng, xry111/loongarch, xry111/loongarch-12.0, xry111/loongarch-12.1, xry111/mips64el, xry111/update-glibc

Children:

a3ebe8a, efd2835

Parents:

8e751f7

Message:

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.

File:

• chapter08/wheel.xml (modified) (7 diffs)

chapter08/wheel.xml

@@ -41 +41 @@
     <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>
@@ -63 +63 @@
         <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>
@@ -70 +70 @@
         <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>
@@ -78 +78 @@
         <term><command>install</command></term>
         <listitem>
-           <para>Install the package.</para>
+           <para>This command installs the package.</para>
         </listitem>
       </varlistentry>
@@ -87 +87 @@
               <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>
@@ -97 +97 @@
         <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>
@@ -129 +129 @@
         <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">