Minor documentation fixes and tweaks.

Author: philthompson10

doc/demo.rst

@@ -47,7 +47,7 @@ Windows  Statically linked OpenSSL          Statically linked OpenSSL
 ======== ================================== ===================================
 
 Before building the demo you must first populate the ``src`` directory with
-appropriate source archives for the following packages:
+appropriate source archives for the following components:
 
 - Python
 - Qt

doc/introduction.rst

@@ -47,7 +47,7 @@ file.
 
 Another companion program :program:`pyqtdeploy-sysroot` provides support for
 creating a system root directory containing target-specific installations of
-certain packages (e.g. Python itself and PyQt).
+certain components (e.g. Python itself and PyQt).
 
 .. note::
 
@@ -65,20 +65,20 @@ There have been a number of changes to :program:`pyqtdeploy` since v1.  Most of
 these changes are related to the supporting tools rather than the GUI.  Project
 files created for v1 are automatically updated by later versions.
 
-Python v3.6 or later is required for Android targets, support for earlier
-versions has been removed.
+Python v3.6 or later is required for Android, support for earlier versions has
+been removed.
 
 v1 recommended a directory structure to adopt when assembling the various parts
 of a deployable application.  This was refered to as the *sysroot* directory.
 An unsupported script, :program:`build-sysroot.py`, was provided that created
 the sysroot directory and was able to build and install a limited number of
-packages - mainly PyQt and related packages.  It used configuration files
-generated by the :program:`pyqtdeploycli` program to specify how those packages
-were built, e.g. which individual modules and features were enabled.
+components - mainly PyQt and related packages.  It used configuration files
+generated by the :program:`pyqtdeploycli` program to specify how those
+components were built, e.g. which individual modules and features were enabled.
 :program:`build-sysroot.py` has been replaced with the fully supported 
-:program:`pyqtdeploy-sysroot` program.  Individual package support is
-implemented by a configurable package plugin.  An API is provided for you to
-write (and contribute) your own plugins for additional packages.  As with v1,
+:program:`pyqtdeploy-sysroot` program.  Individual component support is
+implemented by a configurable component plugin.  An API is provided for you to
+write (and contribute) your own plugins for additional components.  As with v1,
 using the sysroot directory structure is entirely optional.
 
 The :program:`pyqtdeploycli` program has been removed.  The build functionality
@@ -101,7 +101,7 @@ Author
 homepage is https://www.riverbankcomputing.com/software/pyqtdeploy/.
 
 Support may be obtained from the PyQt mailing list at
-https://www.riverbankcomputing.com/mailman/listinfo/pyqt
+https://www.riverbankcomputing.com/mailman/listinfo/pyqt/.
 
 
 License

doc/overview.rst

@@ -29,9 +29,9 @@ by a ``-``.  Note that not all platform/word size combinations are supported.
 - :program:`qmake` is the Qt build system that supports cross-compilation to
   multiple targets.
 
-- :program:`rcc` is a utility that converts arbitrary files in C++ code that
-  implements an embedded filesystem that can be linked as part of an
-  application.
+- :program:`rcc` is a utility that converts arbitrary files to C++ data
+  structures that implement an embedded filesystem that can be linked as part
+  of an application.
 
 - The :program:`QtCore` library implements file access APIs that recognise file
   and directory names that refer to the contents of the embedded filesystem
@@ -40,7 +40,7 @@ by a ``-``.  Note that not all platform/word size combinations are supported.
   the embedded filesystem just as if they were being imported from an ordinary
   filesystem.
 
-Note that :program:`pyqtdeploy` does not itself use PyQt.
+Note that :program:`pyqtdeploy` generated code does not itself use PyQt.
 :program:`pyqtdeploy` can be used to deploy non-PyQt applications, including
 simple command line scripts.  However, as every deployed application is linked
 with the :program:`QtCore` library, you should make sure that you application's

doc/pyqtdeploy.rst

@@ -5,7 +5,7 @@
 Creating a :program:`pyqtdeploy` Project
 ========================================
 
-The first stage of deploying a PyQt application is to create a
+The next stage of deploying a PyQt application is to create a
 :program:`pyqtdeploy` project for it by running::
 
     pyqtdeploy pyqt-demo.pdy
@@ -125,7 +125,7 @@ The tab for defining the application source is shown below.
         enabled.
 
 **Target Python version**
-    is used to specify version of Python that you are targetting.
+    is used to specify version of Python that you are targeting.
 
 **Target PyQt version**
     is used to specify that the application is either a PyQt4 or a PyQt5
@@ -245,8 +245,8 @@ application is shown below.
 
     - *checked* meaning it is explicitly imported by the application
     - *partially checked* meaning it is implicitly imported by the application
-      because an explicitly imported package depends on it, or the Python
-      interpreter itself imports it
+      because another imported package depends on it, or the Python interpreter
+      itself imports it
     - *unchecked* meaning it is not needed by the application.
 
     You should always check a package if the application explicitly imports it,
@@ -259,7 +259,7 @@ application is shown below.
     :mod:`subprocess` modules (amongst others) have been partially checked
     automatically.
 
-The remaining part of the tab relates to non-system libraries that may need to
+The remaining part of the tab relates to additional libraries that may need to
 be linked with the application.  Typically they correspond to packages in the
 standard library that wrap them.  A tab is provided for each target platform so
 that a library can be handled in a platform-specific manner.  If a library is
@@ -268,8 +268,8 @@ library will be enabled.  The corresponding ``DEFINES``, ``INCLUDEPATH`` and
 ``LIBS`` fields will also be editable allowing those values to be set
 appropriately.  If all of those fields are left blank then the external library
 is effectively disabled.  This can be useful if, for example, the original
-Python package is written to use an external library if it is available but to
-fall back to another implementation if not.
+Python package is written to use an external library if it is available but
+will fall back to another implementation if not.
 
 For example, if you have built a static copy of the library
 then you may need to specify the location of the library's header files in the
@@ -381,15 +381,15 @@ project files that can be used without modification across all supported
 targets.  To this end the values of these :program:`qmake` variables may be
 *scoped* with any supported target architecture or platform name.
 
-The scope is specified immediately before the value and separated by a ``#``.
-A scope can take one of the following forms (where *target* is either a target
-architecture or platform):
+The scope is specified immediately before the value and separated from it by a
+``#``.  A scope can take one of the following forms (where *target* is either a
+target architecture or platform):
 
 - *target* where the value applies for the specified target only
 
 - *!target* where the values applies to all targets except the one specified
 
-- *target|target* where the value applies to all of the targets specified.
+- *target|target|...* where the value applies to all of the targets specified.
 
 The most common requirement is to distinguish between Windows and non-Windows
 targets, therefore the most common scopes used will be ``win`` and ``!win``.
@@ -444,7 +444,7 @@ The tab for defining the locations of various files and directories needed by
     :program:`pyqtdeploy` will interpret it correctly on Windows.  It can be
     overridden by the
     :option:`--python-library <pyqtdeploy-build --python-library>` command line
-    option of :program:`pyqtdeploycli`.
+    option of :program:`pyqtdeploy-build`.
 
 **Standard library directory**
     is used to specify the name of the directory containing the target Python

doc/sysroot.rst

@@ -44,7 +44,7 @@ The following component plugins are included as standard with
     installed on :envvar:`PATH`.
 
 **pip**
-    This is a meta-component which can install any number of components that
+    This is a meta-component which will install any number of components that
     can be installed by ``pip``.
 
 **pyqt3d**
@@ -154,7 +154,7 @@ The Python binary installer for macOS from `www.python.org <www.python.org>`__
 includes a patched version of OpenSSL.  The plugin will apply the same patch to
 OpenSSL (on macOS only) if a Python source archive is specified.  The patch
 applies to a specific version of OpenSSL - which one depends on the version of
-Python.
+Python being targeted.
 
 
 qt5
@@ -200,8 +200,8 @@ the MSVC runtime libraries.
 
 For simplicity we have chosen to build a full Qt implementation when building
 from source.  We could have chosen to use the ``configure_options``,
-``disabled_features`` and ``skip`` attributes to tailor the Qt build into to
-reduce the time taken to do the build.
+``disabled_features`` and ``skip`` attributes to tailor the Qt build in order
+to reduce the time taken to do the build.
 
 
 python
@@ -216,11 +216,11 @@ python
     },
 
 The Python component plugin handles installation for both host and target
-architectures.  For the host we choose to use an existing Python installation.
-On Windows the registry is searched for the location of the existing
-installation.  On Linux and macOS the Python interpreter must be on
-:envvar:`PATH`.  For all target architecures we choose to build Python from
-source.
+architectures.  For the host we choose to use an existing Python installation
+rather than build from source.  On Windows the registry is searched for the
+location of the existing installation.  On Linux and macOS the Python
+interpreter must be on :envvar:`PATH`.  For all target architecures we choose
+to build Python from source.
 
 :program:`pyqt-demo` is a very simple application that does not need to
 dynamically load extension modules.  If this was needed then the
@@ -284,8 +284,8 @@ The two attributes used to tailor the build of PyQt5 are ``disabled_features``
 and ``modules``.
 
 Unfortunately the list of features that can be disabled is not properly
-documented and relate to how Qt5 was configured.  However how the attribute is
-set in the above will be appropriate for most cases.
+documented and relate to how Qt5 was configured.  However how
+``disabled_features`` is set in the above will be appropriate for most cases.
 
 The ``modules`` attribute is used to specify the names of the individual PyQt
 extension modules to be built.  We choose to build only those extension
@@ -373,7 +373,7 @@ The full set of command line options is:
     A temporary build directory (called ``build`` in the sysroot) is created in
     order to build the required components.  Normally this is removed
     automatically after all components have been built.  Specifying this option
-    leaves the build directory as it is to make debugging component plugins
+    leaves the build directory in place to make debugging component plugins
     easier.
 
 .. option:: --options
@@ -386,8 +386,8 @@ The full set of command line options is:
     ``DIR`` is added to the list of directories that are searched for component
     plugins.  It may be used more than once to search multiple directories.
     All directories specified in this way will be searched before those
-    directories (internal to :program:`pyqtdeploy-sysroot`) searched by
-    default.
+    directories (internal to :program:`pyqtdeploy-sysroot`) that are searched
+    by default.
 
 .. option:: --source-dir DIR
 
@@ -516,12 +516,13 @@ class is.
     .. py:method:: copy_dir(src, dst, ignore=None)
 
         A directory is copied, optionally excluding file and sub-directories
-        that match a number of patterns.  If the destination directory already
-        exists then it is first removed.  Any errors are handled automatically.
+        that match a number of glob patterns.  If the destination directory
+        already exists then it is first removed.  Any errors are handled
+        automatically.
 
         :param str src: is the name of the source directory.
         :param str dst: is the name of the destination directory.
-        :param list[str] ignore: is an optional sequence of patterns that
+        :param list[str] ignore: is an optional sequence of glob patterns that
             specify files and sub-directories that should be ignored.
 
     .. py:method:: create_file(name)
@@ -538,13 +539,13 @@ class is.
         already exist then it is optionally emptied.  Any errors are handled
         automatically.
 
-        :param str name: is the name of the directory
+        :param str name: is the name of the directory.
         :param bool empty: ``True`` if an existing directory should be emptied.
 
     .. py:method:: decode_version_nr(version_nr)
 
         An encoded version number is decoded to a 3-tuple of major version,
-        minor version and maintenance version.
+        minor version and patch version.
 
         :param int version_nr: is the encoded version number.
         :return: the decoded 3-tuple.
@@ -686,7 +687,7 @@ class is.
 
         Convert a string in the form [M[.m[.p]]] to an encoded version number.
 
-        :param str version_str] is the version number to parse.
+        :param str version_str: is the version number to parse.
         :return: an encoded version number.
 
     .. py:method:: pip_install(package)
@@ -779,7 +780,7 @@ class is.
 
     .. py:method:: unpack_archive(archive, chdir=True)
 
-        An archive (i.e. a ``.tar.gz`` or ``.zip`` file) is unpacked in the
+        An archive (e.g. a ``.tar.gz`` or ``.zip`` file) is unpacked in the
         current directory.
 
         :param str archive: the name of the archive.