Skip to content

Commit

Permalink
Fix spelling errors in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cpina committed Jan 24, 2024
1 parent 679353b commit 54064fe
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/aws-boilerplate.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
If you have AWS credentials configured elsewhere (e.g. in :file:`~/.aws/credentials`), or in the environment, this will use those and you do not need to specifiy credentials in your configuration file.
If you have AWS credentials configured elsewhere (e.g. in :file:`~/.aws/credentials`), or in the environment, this will use those and you do not need to specify credentials in your configuration file.

As a best practice, use an IAM User/Role which is only allowed to access the resources in use.
2 changes: 1 addition & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Reloading
You can send SimpleMonitor a SIGHUP to make it reload its configuration. On
platforms which don't have that (e.g. Windows), you can specify a file to
watch. If the modification time of the file changes, SimpleMonitor will reload
its configration.
its configuration.

Reloading will pick up a change to ``interval`` but no other configuration in
the ``[monitor]`` section. Monitors, Alerters and Loggers are reloaded. You can
Expand Down
2 changes: 1 addition & 1 deletion docs/get-config-values.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Getting configuration values

When loading configuration values for Monitors, Alerters and Loggers, you can use the `get_config_option()` function to perform sanity checks on the loaded config.

.. py:function:: get_config_option(config_options: dict, key: str, [default=None[, required=False[, required_type="str"[, allowed_values=None[, allow_empty=True[, mininum=None[,maximum=None]]]]]]])
.. py:function:: get_config_option(config_options: dict, key: str, [default=None[, required=False[, required_type="str"[, allowed_values=None[, allow_empty=True[, minimum=None[,maximum=None]]]]]]])
Get a config value out of a dict, and perform basic validation on it.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Some of the options include (for the complete list, see :ref:`Loggers<loggers-li
* Sending a message via BulkSMS, Amazon Simple Notification Service (SNS), Telegram, Slack, MQTT (with HomeBridge support) and more
* Writing an HTML status page
* Writing an entry to the syslog (non-Windows only)
* Executing arbitary commands on monitor failure and recovery
* Executing arbitrary commands on monitor failure and recovery

Other features
--------------
Expand Down

0 comments on commit 54064fe

Please sign in to comment.