From 711bff6a609aa5f5c90f0fe5d12820d35e5ca908 Mon Sep 17 00:00:00 2001 From: Marc Bonnici Date: Mon, 27 Apr 2020 12:49:05 +0100 Subject: [PATCH] docs/plugins: Fix formatting and typos --- .../developer_information/developer_reference/plugins.rst | 6 +++--- doc/source/developer_information/how_tos/adding_plugins.rst | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/developer_information/developer_reference/plugins.rst b/doc/source/developer_information/developer_reference/plugins.rst index bfb3e0ab..73e3da16 100644 --- a/doc/source/developer_information/developer_reference/plugins.rst +++ b/doc/source/developer_information/developer_reference/plugins.rst @@ -37,8 +37,8 @@ This section contains reference information common to plugins of all types. The Context ~~~~~~~~~~~ -.. note:: For clarification on the meaning of "workload specification" ("spec"), "job" - and "workload" and the distiction between them, please see the :ref:`glossary `. +.. note:: For clarification on the meaning of "workload specification" "spec", "job" + and "workload" and the distinction between them, please see the :ref:`glossary `. The majority of methods in plugins accept a context argument. This is an instance of :class:`wa.framework.execution.ExecutionContext`. It contains @@ -158,7 +158,7 @@ irrespective of the host's path notation. For example: .. note:: Output processors, unlike workloads and instruments, do not have their own target attribute as they are designed to be able to be run offline. -.. _plugin-parmeters: +.. _plugin-parameters: Parameters ~~~~~~~~~~~ diff --git a/doc/source/developer_information/how_tos/adding_plugins.rst b/doc/source/developer_information/how_tos/adding_plugins.rst index 4ed57095..ce502494 100644 --- a/doc/source/developer_information/how_tos/adding_plugins.rst +++ b/doc/source/developer_information/how_tos/adding_plugins.rst @@ -120,7 +120,7 @@ separated by a new line. ''' In order to allow for additional configuration of the workload from a user a -list of :ref:`parameters ` can be supplied. These can be +list of :ref:`parameters ` can be supplied. These can be configured in a variety of different ways. For example here we are ensuring that the value of the parameter is an integer and larger than 0 using the ``kind`` and ``constraint`` options, also if no value is provided we are providing a