sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-04-20 09:40:50 +01:00
Code Issues Releases Wiki Activity

docs/plugins: Fix formatting and typos

Browse Source
This commit is contained in:
Marc Bonnici 2020-04-27 12:49:05 +01:00 committed by setrofim
parent 2a8454db6a
commit 711bff6a60
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/developer_information/developer_reference/plugins.rst
View File

@ -37,8 +37,8 @@ This section contains reference information common to plugins of all types.
The Context The Context
~~~~~~~~~~~ ~~~~~~~~~~~
.. note:: For clarification on the meaning of "workload specification" ("spec"), "job" .. note:: For clarification on the meaning of "workload specification" "spec", "job"
and "workload" and the distiction between them, please see the :ref:`glossary <glossary>`. and "workload" and the distinction between them, please see the :ref:`glossary <glossary>`.
The majority of methods in plugins accept a context argument. This is an The majority of methods in plugins accept a context argument. This is an
instance of :class:`wa.framework.execution.ExecutionContext`. It contains 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 .. 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. own target attribute as they are designed to be able to be run offline.
.. _plugin-parmeters: .. _plugin-parameters:
Parameters Parameters
~~~~~~~~~~~ ~~~~~~~~~~~

2
doc/source/developer_information/how_tos/adding_plugins.rst
View File

@ -120,7 +120,7 @@ separated by a new line.
''' '''
In order to allow for additional configuration of the workload from a user a In order to allow for additional configuration of the workload from a user a
list of :ref:`parameters <plugin-parmeters>` can be supplied. These can be list of :ref:`parameters <plugin-parameters>` can be supplied. These can be
configured in a variety of different ways. For example here we are ensuring that 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`` 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 and ``constraint`` options, also if no value is provided we are providing a