From 140c918451d5e79e2a413cdd6d8c969191aa9d75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1t=C3=A9=20Balajti?= Date: Fri, 15 Nov 2024 13:44:22 +0100 Subject: [PATCH] update style --- docs/guides/examples.rst | 6 +++--- docs/guides/installation.rst | 2 +- docs/guides/usage.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/guides/examples.rst b/docs/guides/examples.rst index 9f2ad42..d9b5873 100644 --- a/docs/guides/examples.rst +++ b/docs/guides/examples.rst @@ -4,7 +4,7 @@ Examples `HTSinfer` provides easy-to-use commands for analyzing single- and paired-ended RNA-Seq libraries. -Single-ended Library Example +Single-ended library example ---------------------------- To run `HTSinfer` on a single-ended RNA-Seq library, use the following command: @@ -13,7 +13,7 @@ To run `HTSinfer` on a single-ended RNA-Seq library, use the following command: htsinfer tests/files/adapter_single.fastq -Paired-ended Library Example +Paired-ended library example ---------------------------- To run `HTSinfer` on a paired-ended RNA-Seq library, use the following command: @@ -24,7 +24,7 @@ To run `HTSinfer` on a paired-ended RNA-Seq library, use the following command: Both commands will output the results in JSON format to :code:`STDOUT` and the log to :code:`STDERR`. -Example Output +Example output -------------- Here is a sample output for the paired-ended library: diff --git a/docs/guides/installation.rst b/docs/guides/installation.rst index d734156..aa8f9e1 100644 --- a/docs/guides/installation.rst +++ b/docs/guides/installation.rst @@ -50,7 +50,7 @@ After the installation is complete, activate the :code:`htsinfer` Conda environm conda activate htsinfer -Verify the Installation (Optional) +Verify the installation (optional) ---------------------------------- If you have installed the development or testing dependencies, you can verify that `HTSinfer` was installed correctly by executing the tests shipped with the package: diff --git a/docs/guides/usage.rst b/docs/guides/usage.rst index 4c7631e..c06e184 100644 --- a/docs/guides/usage.rst +++ b/docs/guides/usage.rst @@ -3,7 +3,7 @@ Usage This section describes the general usage of `HTSinfer`. -General Usage +General usage ------------- .. code-block:: bash @@ -30,7 +30,7 @@ General Usage The above command allows the user to infer metadata for single- or paired-ended RNA-Seq libraries by specifying file paths and relevant parameters. The tool outputs metadata in JSON format to :code:`STDOUT` and logs to :code:`STDERR`. -Command-line Options +Command-line options --------------------- Available command-line parameters are categorized as follows: