Docs fixes and updates

Signed-off-by: Craig Zerouni <czerouni@gmail.com>

Author: czerouni

docs/source/caching.rst

@@ -11,7 +11,7 @@ Memcached is widely used, easy to deploy (because there is no storage needed sin
 process/executable), and is very fast due to the data residing in memory.
 
 In a studio environment (with many machines), machines that perform a solve that is already cached to the
-resolve cache will simply receive the cached result rather than preforming a re-solve. This can significantly
+resolve cache will simply receive the cached result rather than performing a re-solve. This can significantly
 decrease the time it takes to resolve environments. Slow solves will now be almost instantaneous.
 
 Resolve caching has almost no downsides. Only in rare edge cases where you have to "hack" a released package into
@@ -27,13 +27,13 @@ The following information is stored to the memcached server for each solve:
 * Timestamps of packages seen in previous solves.
 * Variant states information about the state of a variant. For example, in the 'filesystem' repository type,
   the 'state' is the last modified date of the file associated with the variant (perhaps a package.py).
-  If the state of any variant has changed from a cached resolve - eg. if a file has been modified - the cached resolve is discarded.
+  If the state of any variant has changed from a cached resolve - e.g. if a file has been modified - the cached resolve is discarded.
 
 Setup
 -----
 
 To enable memcached caching, you need to configure the :data:`memcached_uri` config variable.
-This variable accepts a list of URI to your memcached servers or None. Example with memcached running on
+This variable accepts a list of URIs to your memcached servers or None. Example with memcached running on
 localhost on its default port:
 
 .. code-block:: python
@@ -180,7 +180,7 @@ you should **not** enable caching on package repositories where packages may get
 overwritten. It is for this reason that caching is disabled for local packages by
 default (see :data:`package_cache_local`).
 
-Control Disk Usage
+Controlling Disk Usage
 ------------------
 
 You can control the disk usage of the package cache by using the
@@ -191,8 +191,8 @@ them to your liking.
 Another way to control the disk usage is to run the :option:`rez-pkg-cache --clean` command
 either manually or as a cron job. See :ref:`caching-cleaning-the-cache`.
 
-Commandline Tool
-----------------
+Command Line Tool
+-----------------
 
 Inspection
 ++++++++++
@@ -232,7 +232,7 @@ Cached variants have one of the following statuses at any given time:
 Logging
 +++++++
 
-Caching operations are stored into logfiles within the cache directory. To view:
+Caching operations are stored into log files within the cache directory. To view:
 
 .. code-block:: console
 

docs/source/configuring_rez.rst

@@ -11,9 +11,9 @@ Settings are determined in the following way:
 - The setting is then overridden if it is present in another settings file pointed at by the
   :envvar:`REZ_CONFIG_FILE` environment variable. This can also be a path-like variable, to read from
   multiple configuration files;
-- The setting is further overriden if it is present in ``$HOME/.rezconfig`` or ``$HOME/.rezconfig.py``;
+- The setting is further overridden if it is present in ``$HOME/.rezconfig`` or ``$HOME/.rezconfig.py``;
 - The setting is overridden again if the environment variable :envvar:`REZ_XXX` is present, where ``XXX`` is
-  the uppercase version of the setting key. For example, :data:`.image_viewer` will be overriden by
+  the uppercase version of the setting key. For example, :data:`.image_viewer` will be overridden by
   :envvar:`REZ_IMAGE_VIEWER`.
 - This is a special case applied only during a package build or release. In this case, if the
   package definition file contains a "config" section, settings in this section will override all
@@ -109,12 +109,12 @@ JSON formats are supported:
    # in rezconfig
    default_relocatable_per_package = DelayLoad('/svr/configs/rez_relocs.yaml')
 
-See :Class:`.DelayLoad`.
+See :class:`.DelayLoad`.
 
 .. _configuring-rez-commandline-line:
 
-Commandline Tool
-================
+Command Line Tool
+=================
 
 You can use the :ref:`rez-config` command line tool to see what the current configured settings are.
 Called with no arguments, it prints all settings; if you specify an argument, it prints out just
@@ -145,6 +145,6 @@ Following is an alphabetical list of rez settings.
    file in the rez source, so you can also refer to that file for the same information.
 
 .. This is a custom directive. See the rez_sphinxext.py file for more information.
-.. TL;DR: It will take care of generating the documentation or all the settings defined
+.. TL;DR: It will take care of generating the documentation for all the settings defined
 .. in rezconfig.py
 .. rez-config::

docs/source/environment.rst

@@ -102,7 +102,7 @@ dots replaced with underscore.
 
 .. envvar:: REZ_(PKG)_PATCH_VERSION
 
-   The patch version of the package, or an emopty string.
+   The patch version of the package, or an empty string.
 
 Ephemeral packages environment variables
 ----------------------------------------
@@ -216,7 +216,7 @@ operation of rez.
    For any given rez config entry (see ``rezconfig.py``),
    you can override the setting with an environment variable, for convenience. Here,
    ``XXX`` is the uppercased equivalent of the setting name. For example,
-   a setting commonly overriden this way is :data:`packages_path`, whos equivalent
+   a setting commonly overridden this way is :data:`packages_path`, whose equivalent
    variable is :envvar:`REZ_PACKAGES_PATH`.
 
    .. hint::
@@ -234,7 +234,7 @@ operation of rez.
 
 .. envvar:: EDITOR
 
-   On Linux and OSX systems, this will set the default editor to use
+   On Linux and macOS systems, this will set the default editor to use
    if and when rez requires one (an example is on release if the :data:`prompt_release_message`
    config setting is true).
 
@@ -259,18 +259,18 @@ Development Environment Variables
 .. envvar:: REZ_LOG_DEPRECATION_WARNINGS
 
    Enable all deprecation warnings to be logged regardless of how you have configured
-   your python interpreter. This is usefull to help upgrading to newer versions of rez.
+   your python interpreter. This is useful to help upgrading to newer versions of rez.
    Prior to updating, you should set this environment variable to see if you need to
    change some things to be compatible with newer versions.
 
    .. warning::
 
       Enabling this will forcefully load every configuration file instead of loading them
-      lazilly. This can have an impact on startup time.
+      lazily. This can have an impact on startup time.
 
 .. envvar:: REZ_SIGUSR1_ACTION
 
-   If you set this to ``print_stack``, rez will prints its
+   If you set this to ``print_stack``, rez will print its
    current stacktrace to stdout if sent a USR1 signal. This is for debugging purposes only.
 
 .. envvar:: _REZ_NO_KILLPG

docs/source/ephemerals.rst

@@ -7,7 +7,7 @@ Ephemerals
 Ephemeral packages (or simply 'ephemerals') are requests for packages that do not
 exist. Ephemeral package names always begin with a dot (``.``). Like all package
 requests, ephemerals can be requested as part of packages' requires or variants
-lists, or directly by the user (via :ref:`rez-env` for eg).
+lists, or directly by the user (via :ref:`rez-env` for e.g.).
 
 Example:
 
@@ -101,10 +101,10 @@ etc) is present in the resolve. Note that the leading ``.`` is implied and not
 included when querying the :attr:`ephemerals` object.
 
 .. warning::
-   Since :attr:`ephemerals` is a dict-like object, so it has
-   a ``get`` function which will return a full request string if key exists. Hence,
+   Since :attr:`ephemerals` is a dict-like object, it has
+   a ``get`` function which will return a full request string if the key exists. Hence,
    the default value should also be a full request string, not just a version range
-   string like ``0`` in :func:`ephemerals.get_range`. Or :func:`intersects` may not work as expect.
+   string like ``0`` in :func:`ephemerals.get_range`. Otherwise, :func:`intersects` may not work as expected.
 
 Ephemeral Use Cases
 ===================
@@ -162,7 +162,7 @@ Abstract Package Representation
 Sometimes it makes sense for a package to require some form of abstract object or
 capability, rather than an actual package. For example, perhaps your package (or
 one of its variants) requires a GPU to be present on the host machine. To support
-this, you might have something setup that includes a ``.gpu-1`` ephemeral in the
+this, you might have something set up that includes a ``.gpu-1`` ephemeral in the
 :ref:`implicits <implicit-packages-concept>` list on all GPU-enabled hosts.
 Then, your package could look like this:
 
@@ -176,7 +176,7 @@ Then, your package could look like this:
    ]
 
 .. warning::
-   Be aware that on hosts that do **not** have a gpu
+   Be aware that on hosts that do **not** have a GPU
    implicit, either variant could be selected. You would want to either guarantee
-   that every host has the gpu implicit set to 0 or 1, or that the user always
+   that every host has the GPU implicit set to 0 or 1, or that the user always
    explicitly specifies ``.gpu-0`` or ``.gpu-1`` in their request.

docs/source/getting_started.rst

@@ -7,7 +7,7 @@ Essential packages
 
 .. warning::
    :ref:`rez-bind` is going to be deprecated. The current implementation is not actively maintained.
-   Especially on windows, using :option:`--quickstart <rez-bind --quickstart>` is likely to fail.
+   Especially on Windows, using :option:`--quickstart <rez-bind --quickstart>` is likely to fail.
 
    Even if rez-bind will be deprecated and we generally discourage its use, you can safely use it for creating the ``arch``, ``os`` and ``platform`` packages.
 
@@ -144,7 +144,7 @@ You can use the :ref:`rez-env` tool to request a configured environment containi
    > ]$ █
 
 Now you are within the configured environment. The caret (``>``) prefixed to your prompt is a visual
-cue telling you that you're within a rez-configured subshell. Rez does not update the currect environment,
+cue telling you that you're within a rez-configured subshell. Rez does not update the current environment,
 instead it configures a subshell and puts you within it.
 
 Now you can run the ``hello`` tool in our ``hello_world`` package:
@@ -176,7 +176,7 @@ initially created the environment:
    platform-osx       /home/ajohns/packages/platform/osx                                           (local)
    python-2.7.11      /home/ajohns/packages/python/2.7.11/platform-osx/arch-x86_64/os-osx-10.11.5  (local)
 
-To exit the configured environment, simply exist the shell using the ``exit`` command or :kbd:`Control-d`:
+To exit the configured environment, simply exit the shell using the ``exit`` command or :kbd:`Control-d`:
 
 You can also create a configured environment and run a command inside of it, with a single command.
 When you use this form, the shell is immediately exited after the command runs:

docs/source/guides/update_to_3.rst

@@ -3,7 +3,7 @@ Update to rez 3.0.0
 ===================
 
 Rez ``3.0.0`` is not be a major breaking change, except that Python 2 is not supported anymore.
-There is various other small changes too.
+There are various other small changes too.
 
 This guide will show you how to prepare before upgrading to ``3.0.0``. We hope that this guide will
 help make the upgrade process smoother.
@@ -22,7 +22,7 @@ Steps for smooth upgrade
    if you wish.
 
    You should prefer 2.114.1 over 2.114.0 because 2.114.0 contained a bug that prevented
-   rez from correctly running when :envvar:`REZ_LOG_DEPRECATION_WARNINGS` is set.
+   rez from correctly running when :envvar:`REZ_LOG_DEPRECATION_WARNINGS` was set.
 
    .. warning::
 

docs/source/index.rst

@@ -89,5 +89,5 @@ ways to get in touch with us:
 * `Report an issue <https://github.com/AcademySoftwareFoundation/rez/issues>`_
 * `Chat room <https://slack.aswf.io>`_: Join the ``#rez`` channel
 * `Start a discussion <https://github.com/AcademySoftwareFoundation/rez/discussions>`_
-* `Mailing list <mail:main@lists.aswf.io>`_: Note that are way less active on the mailing
+* `Mailing list <mail:main@lists.aswf.io>`_: Note that we are far less active on the mailing
   list than on any other communication channel.

docs/source/installation.rst

@@ -7,7 +7,7 @@ Installation Script
 
 To install rez, you will need:
 
-1. Python 3.8 or above. We support 3.8, 3.9, 3.10, 3.11, 3.12 and 3.13.
+1. Python 3.7 or above. We support 3.7, 3.8, 3.9, 3.10, and 3.11.
    The python interpreter you use to run the install script will be the interpreter
    used by rez itself.
 2. The source code. You can get it by either cloning the `repository <https://github.com/AcademySoftwareFoundation/rez>`_

docs/source/managing_packages.rst

@@ -10,7 +10,7 @@ repository, but it will not be visible to the rez API nor to any newly resolved
 runtimes. Any runtimes that are currently using an ignored package are unaffected,
 since the package's payload has not been removed.
 
-To ignore a package via commandline:
+To ignore a package via command line:
 
 .. code-block:: console
 
@@ -36,7 +36,7 @@ Via API:
 Both of these options generate a :file:`.ignore{{version}}` file (e.g.
 ``.ignore3.1.2``) next to the package version directory.
 
-You can also do the reverse (ie unignore a package). Use the :option:`-u <rez-pkg-ignore -u>` option of
+You can also do the reverse (i.e. unignore a package). Use the :option:`-u <rez-pkg-ignore -u>` option of
 :ref:`rez-pkg-ignore`, or the :meth:`~rez.package_repository.PackageRepository.unignore_package` method on the package repository
 object.
 
@@ -46,7 +46,7 @@ Copying Packages
 Packages can be copied from one :ref:`package repository <package-repositories-concept>`
 to another, like so:
 
-Via commandline:
+Via command line:
 
 .. code-block:: console
 
@@ -117,7 +117,7 @@ to another. Be aware that moving a package does not actually delete the source
 package however. Instead, the source package is hidden (ignored). It is up to
 you to delete it at some later date.
 
-To move a package via commandline:
+To move a package via command line:
 
 .. code-block:: console
 
@@ -143,7 +143,7 @@ Via API:
    None
 
 Be aware that a non-relocatable package is also not movable (see
-:attr:`here <relocatable>`. Like package
+:attr:`here <relocatable>`). Like package
 copying, there is a ``force`` option to move it regardless.
 
 A typical reason you might want to move a package is to archive packages that are
@@ -164,7 +164,7 @@ Packages can be removed. This is different from ignoring. The package and its
 payload is deleted from storage, whereas ignoring just hides it. It is not
 possible to un-remove a package.
 
-To remove a package via commandline:
+To remove a package via command line:
 
 .. code-block:: console