From 44eeedf1aa70d93f4feee4b055619c5e428a4499 Mon Sep 17 00:00:00 2001 From: Michael Rapp Date: Sun, 24 Dec 2023 15:11:23 +0100 Subject: [PATCH] Minor spelling changes. --- doc/quickstart/installation.rst | 2 +- doc/quickstart/testbed.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/quickstart/installation.rst b/doc/quickstart/installation.rst index d438ee4546..26d26ba8f5 100644 --- a/doc/quickstart/installation.rst +++ b/doc/quickstart/installation.rst @@ -5,7 +5,7 @@ Installation All algorithms that are provided as part of this project are published on `PyPi `__. As shown below, they can easily be installed via the Python package manager `pip `_. Unless you intend to modify the algorithms' source code, in which case you should have a look at the section :ref:`compilation`, this is the recommended way for installing the software. -Installing the BOOMER algorithm +Installing the BOOMER Algorithm ------------------------------- The BOOMER algorithm is published as the Python package `mlrl-boomer `__. It can be installed via the following command: diff --git a/doc/quickstart/testbed.rst b/doc/quickstart/testbed.rst index 30e6c28a26..88eabd66ab 100644 --- a/doc/quickstart/testbed.rst +++ b/doc/quickstart/testbed.rst @@ -20,8 +20,8 @@ In the following, a minimal working example of how to use the command line API f Both arguments that are included in the above command are mandatory: -* ``--data-dir``: An absolute or relative path to the directory where the data set files are located. -* ``--dataset``: The name of the data set files (without suffix). +* ``--data-dir`` An absolute or relative path to the directory where the data set files are located. +* ``--dataset`` The name of the data set files (without suffix). The program expects the data set files to be provided in the `Mulan format `_. It requires two files to be present in the specified directory: