Skip to content

Commit

Permalink
docs: fix typos (#1577)
Browse files Browse the repository at this point in the history
* docs: fix typos

* configuration.rst: align comment and code

This aligns the example with
https://datacube-core.readthedocs.io/en/develop-1.9/MIGRATION-1.8-to-1.9.html#the-new-postgis-index-driver
  • Loading branch information
pjonsson committed Apr 17, 2024
1 parent 93e1d01 commit c0e4b89
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
2 changes: 2 additions & 0 deletions docs/about/whats_new.rst
Expand Up @@ -8,6 +8,8 @@ What's New
v1.9.next
=========

- Fix typos in docs (:pull:`1577`)

v1.9.0-rc4 (15th April 2024)
============================

Expand Down
14 changes: 7 additions & 7 deletions docs/installation/database/configuration.rst
Expand Up @@ -39,7 +39,7 @@ looks something like this:
# This is a YAML file and the # symbol marks comments
default:
# The 'default' environment is used if now environment is specified.
# The 'default' environment is used if no environment is specified.
# It is often convenient to define it as an alias to another environment
alias: prod
Expand All @@ -57,7 +57,7 @@ looks something like this:
dev:
# Dev use the new PostGIS-based ODC index schema.
index_driver: postgres
index_driver: postgis
db_url: postgresql://user:passwd@internal.server.domain:5555/development_db
db_connection_timeout: 120
Expand Down Expand Up @@ -106,7 +106,7 @@ Configuration Environments

A valid configuration file consists of one or more named environment definition sections.

Evironment names must start with a lowercase letter and can only include lowercase
Environment names must start with a lowercase letter and can only include lowercase
letters and digits. (This restriction it to support generic environment variable
overrides, as discussed below.)

Expand Down Expand Up @@ -223,7 +223,7 @@ specified per-environment.

Database connection details can be specified in a single option with the
``db_url`` field. If a ``db_url`` is not provided, connection details can
be specfied with separate :confval:`db_hostname`, :confval:`db_port`, :confval:`db_database`,
be specified with separate :confval:`db_hostname`, :confval:`db_port`, :confval:`db_database`,
:confval:`db_username`, and :confval:`db_password` fields, as described below.

If a `db_url` is provided, it takes precedence over the separate connection
Expand Down Expand Up @@ -300,7 +300,7 @@ specified per-environment.
Defaults to False.

.. code-block::
:caption: Example showing :confval:`db_iam_authenticaion`
:caption: Example showing :confval:`db_iam_authentication`
[main]
index_driver: postgis
Expand Down Expand Up @@ -602,7 +602,7 @@ Notes:
4b. Environment Variable Overrides and Environment Aliases
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

To avoid troublesome and unpredictable corner carse, aliases can only be
To avoid troublesome and unpredictable corner cases, aliases can only be
defined in raw configuration or in config files - they cannot be defined
through environment variables.

Expand Down Expand Up @@ -721,7 +721,7 @@ a new preferred environment variable, as listed in the table below.
The auto_config() function
--------------------------

There used to be an undocumentd ``auto_config()`` function (also available through ``python -m datacube``) that read
There used to be an undocumented ``auto_config()`` function (also available through ``python -m datacube``) that read
in the configuration (from multiple files and environment variables) and wrote it out as a single consolidated
configuration file.

Expand Down
2 changes: 1 addition & 1 deletion docs/installation/setup/windows.rst
Expand Up @@ -34,7 +34,7 @@ Add conda-forge to package channels::

conda config --add channels conda-forge

Conda Environments are recommended for use in isolating your ODC development environment from your system installation and other python evironments.
Conda Environments are recommended for use in isolating your ODC development environment from your system installation and other python environments.

Install required python packages and create an ``odc`` conda environment.

Expand Down

0 comments on commit c0e4b89

Please sign in to comment.