Skip to content
This repository was archived by the owner on Apr 9, 2026. It is now read-only.

Commit 0d734ff

Browse files
Fix trailing whitespace, HTTP links, and TODO comments
Co-authored-by: timosachsenberg <5803621+timosachsenberg@users.noreply.github.com>
1 parent 837fcd1 commit 0d734ff

23 files changed

Lines changed: 163 additions & 166 deletions

docs/about/installation/installation-on-macos.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ To install OpenMS on macOS, run the following steps:
1313
2.Double click on the downloaded file. It will start to open the `OpenMS-<version>-macOS.pkg` installer file.
1414

1515
```{image} /_images/installations/macos/Warning-openMS-3.3.0-macOS-Silicon.pkg-Not-Opened.png
16-
:alt: macOS warning message when opening OpenMS-<version>-macOS.pkg
17-
:width: 500px
16+
:alt: macOS warning message when opening OpenMS-<version>-macOS.pkg
17+
:width: 500px
1818
```
1919
**Why This Warning Appears:**
2020

@@ -24,39 +24,39 @@ The warning indicates that the OpenMS installer hasn't been notarized or recogni
2424

2525
Bypassing Gatekeeper to Install OpenMS on macOS
2626

27-
A. Bypassing Gatekeeper Using System Settings
27+
A. Bypassing Gatekeeper Using System Settings
2828

29-
1. Open **System Settings**.
30-
2. Navigate to **Privacy & Security**.
31-
3. Under the **Security** section, locate the message about the blocked application.
32-
4. Click the **Open Anyway** button .
29+
1. Open **System Settings**.
30+
2. Navigate to **Privacy & Security**.
31+
3. Under the **Security** section, locate the message about the blocked application.
32+
4. Click the **Open Anyway** button .
3333

3434
```{image} /_images/installations/macos/Bypassing-Gatekeeper-to-Install-OpenMS-on-macOS.png
35-
:alt: Bypassing Gatekeeper on macOS
36-
:width: 500px
35+
:alt: Bypassing Gatekeeper on macOS
36+
:width: 500px
3737
```
38-
B. Bypassing Gatekeeper Using Command-Line
38+
B. Bypassing Gatekeeper Using Command-Line
3939

40-
For users comfortable with the command line, you can bypass the security warning using Terminal:
40+
For users comfortable with the command line, you can bypass the security warning using Terminal:
4141

42-
1. Open **Terminal**.
43-
2. Navigate to the directory containing the installer using the `cd` command:
42+
1. Open **Terminal**.
43+
2. Navigate to the directory containing the installer using the `cd` command:
4444

4545
```bash
4646
cd /path/to/installer
4747
```
48-
3. Run the following command to remove the quarantine attribute:
48+
3. Run the following command to remove the quarantine attribute:
4949

5050
```bash
5151
xattr -d com.apple.quarantine OpenMS-<version>-macOS.pkg
5252
```
53-
By following these steps, you’re instructing macOS to trust the OpenMS installer and allow its execution. Ensure that you’ve downloaded the installer from a **trusted source** (i.e., build archive of the Unversity of Tübingen or OpenMS' GitHub artifacts) before proceeding.
53+
By following these steps, you’re instructing macOS to trust the OpenMS installer and allow its execution. Ensure that you’ve downloaded the installer from a **trusted source** (i.e., build archive of the Unversity of Tübingen or OpenMS' GitHub artifacts) before proceeding.
5454

55-
4. Install OpenMS
55+
4. Install OpenMS
5656

5757
```{image} /_images/installations/macos/Installation-successful-message.png
58-
:alt: OpenMS installation started on macOS
59-
:width: 500px
58+
:alt: OpenMS installation started on macOS
59+
:width: 500px
6060
```
6161

6262
5. Agree to the license agreements.
@@ -69,16 +69,16 @@ By following these steps, you’re instructing macOS to trust the OpenMS install
6969
6. Installation Confirmation
7070

7171
```{image} /_images/installations/macos/Installation-successful-message.png
72-
:alt: OpenMS installation successful
73-
:width: 500px
72+
:alt: OpenMS installation successful
73+
:width: 500px
7474
```
7575

7676
To use {term}`TOPP` as regular app in the shell, add the following lines to the `~/.profile` file.
7777

7878
:::{warning} Known Installer Issues
7979

8080
1. Nothing happens when you click OpenMS apps or the validity of the developer could not be confirmed.
81-
81+
8282
This usually means the OpenMS software lands in quarantine even after installation of the `.pkg`. This was more common with our older `.dmg` image but may still happen.
8383
Since macOS Catalina (maybe also Mojave) all apps and executables have to be officially notarized by Apple but we
8484
currently do not have the resources for a streamlined notarization workflow.
@@ -91,7 +91,7 @@ To use {term}`TOPP` as regular app in the shell, add the following lines to the
9191
cd /Applications/OpenMS-<version>
9292
sudo xattr -r -d com.apple.quarantine *
9393
```
94-
94+
9595
2. Bug with running Java based thirdparty tools like {term}`MSGFPlusAdapter` and {term}`LuciphorAdapter` from within **TOPPAS.app**
9696

9797
If you face issues while running Java based thirdparty tools from within {term}`TOPPAS.app <TOPPAS>`, run the {term}`TOPPAS.app <TOPPAS>`

docs/about/installation/installation-on-windows.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Windows
55

66
To Install the binary package of OpenMS & {term}`TOPP`:
77

8-
1. Download the installer `OpenMS-<version>-Win64.exe` from the [archive](https://abibuilder.cs.uni-tuebingen.de/archive/openms/OpenMSInstaller/release/latest/)
8+
1. Download the installer `OpenMS-<version>-Win64.exe` from the [archive](https://abibuilder.cs.uni-tuebingen.de/archive/openms/OpenMSInstaller/release/latest/)
99
2. Execute the installer under the user account that later runs OpenMS and follow its instructions.
10-
10+
1111
You may see a Windows Defender Warning, since our installer is not digitally signed.
12-
12+
1313
Click on "More Info", and then "Run anyways".
14-
14+
1515
![](/_images/installations/win/smartscreen.gif)
1616

1717
When asked for an admin authentication, please enter the credentials (it is not advised to directly invoke the installer using an admin account).
@@ -47,4 +47,4 @@ The windows installer works with Windows 10 and 11 (older versions might still w
4747
4. For Win8 or later, Windows will report an error while installing `.net4` as it's mostly included. But it might occur
4848
that `.net3.5` does not get properly installed during the process.
4949

50-
Fix is to enable the .NET Framework 3.5 yourself through Control Panel. See this [Microsoft help page](https://docs.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows).aspx#ControlPanel) for detailed information. Even if this step fails, this does not affect the functionality of OpenMS, except for the executability of included third party tools (ProteoWizard).
50+
Fix is to enable the .NET Framework 3.5 yourself through Control Panel. See this [Microsoft help page](https://docs.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows#enable-the-net-framework-35-in-control-panel) for detailed information. Even if this step fails, this does not affect the functionality of OpenMS, except for the executability of included third party tools (ProteoWizard).

docs/about/installation/installation-with-conda.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ obtain release versions (`bioconda` channel) and nightly versions (`openms` chan
8181
:::{tab-item} openms
8282
:sync: openms
8383

84-
```{code-block} bash
84+
```{code-block} bash
8585
conda install openms
8686
```
8787
:::
@@ -119,7 +119,7 @@ obtain release versions (`bioconda` channel) and nightly versions (`openms` chan
119119
:::{tab-item} openms
120120
:sync: openms
121121

122-
```{code-block} bash
122+
```{code-block} bash
123123
conda install -c openms openms
124124
```
125125
:::

docs/about/learning/background.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Learning
22
========
33

4-
Proteomics and metabolomics focus on complex interactions within biological systems; the former is centered on proteins while the latter is based on metabolites. To understand these interactions, we need to accurately identify the different biological components involved.
4+
Proteomics and metabolomics focus on complex interactions within biological systems; the former is centered on proteins while the latter is based on metabolites. To understand these interactions, we need to accurately identify the different biological components involved.
55

6-
{term}`Liquid chromatography` (LC) and {term}`mass spectrometry` (MS) are the analytical techniques used to isolate and identify biological components in proteomics and metabolomics. LC-MS data can be difficult to analyze manually given its amount and complexity. Therefore, we need specialized software that can analyze high-throughput LC-MS data quickly and accurately.
6+
{term}`Liquid chromatography` (LC) and {term}`mass spectrometry` (MS) are the analytical techniques used to isolate and identify biological components in proteomics and metabolomics. LC-MS data can be difficult to analyze manually given its amount and complexity. Therefore, we need specialized software that can analyze high-throughput LC-MS data quickly and accurately.
77

88
<ins>**Why use OpenMS**</ins>
99

@@ -13,7 +13,7 @@ OpenMS is an open-source, C++ framework for analyzing large volumes of mass spec
1313
OpenMS in recent times has been expanded to support a wide variety of mass spectrometry experiments. To design your analysis solution, [contact the OpenMS team](https://openms.de/communication/) today.
1414
```
1515

16-
To use OpenMS effectively, an understanding of chromatography and mass spectrometry is required as many of the algorithms are based on these techniques.
16+
To use OpenMS effectively, an understanding of chromatography and mass spectrometry is required as many of the algorithms are based on these techniques.
1717
This section provides a detailed explanation on LC and MS, and how they are combined to identify and quantify substances.
1818

1919

docs/about/learning/lc-chromatography.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
Liquid chromatography (LC)
22
==========================
33

4-
Chromatography is a technique used by life scientists to separate molecules based on a specific physical or chemical property.
4+
Chromatography is a technique used by life scientists to separate molecules based on a specific physical or chemical property.
55

66
<div class="admonition video">
77
<p class="admonition-title">**Video**</p>
88
For more information on chromatography, [view this video](https://timms.uni-tuebingen.de:/tp/UT_20141028_001_cpm_0001?t=210.00).
99
</div>
1010

11-
There are many types of chromatography, but this section focuses on LC as it is widely used in proteomics and metabolomics.
11+
There are many types of chromatography, but this section focuses on LC as it is widely used in proteomics and metabolomics.
1212

1313
LC separates molecules based on a specific physical or chemical property by mixing a sample containing the molecules of interest (otherwise known as **analytes**) in a liquid solution.
1414

1515
## Key components of LC
1616

1717
An LC setup is made up of the following components:
18-
- **A liquid solution**, known as the **mobile phase**, containing the analytes.
18+
- **A liquid solution**, known as the **mobile phase**, containing the analytes.
1919
- **A pump** which transports the liquid solution.
2020
- **A stationary phase** which is a solid, homogeneous substance.
21-
- **A column** that contains the stationary phase.
21+
- **A column** that contains the stationary phase.
2222
- **A detector** that plots the time it takes for the analyte to escape the column (retention time) against the analyte's concentration. This plot is called a **chromatogram**.
2323

24-
Refer to the image below for a diagrammatic representation of an LC setup.
24+
Refer to the image below for a diagrammatic representation of an LC setup.
2525

2626
![schematic illustration of an LC setup](/_images/introduction/lc-components.png)
2727

2828
## How does LC work?
2929

30-
The liquid solution containing the analytes is pumped through a column that is attached to the stationary phase. Analytes are separated based on how strongly they interact with each phase. Some analytes will interact strongly with the mobile phase while others will be strongly attracted to the stationary phase, depending on their physical or chemical properties. The stronger an analyte's attraction is to the mobile phase, the faster it will leave the column. The time it takes for an analyte to escape from the column is called the analyte's {term}`retention time`. As a result of their differing attractions to the mobile and stationary phases, different analytes will have different retention times, which is how separation occurs.
30+
The liquid solution containing the analytes is pumped through a column that is attached to the stationary phase. Analytes are separated based on how strongly they interact with each phase. Some analytes will interact strongly with the mobile phase while others will be strongly attracted to the stationary phase, depending on their physical or chemical properties. The stronger an analyte's attraction is to the mobile phase, the faster it will leave the column. The time it takes for an analyte to escape from the column is called the analyte's {term}`retention time`. As a result of their differing attractions to the mobile and stationary phases, different analytes will have different retention times, which is how separation occurs.
3131

3232
The retention times for each analyte are recorded by a detector. The most common detector used is the mass spectrometer, which we discuss later. However, other detection methods exist, such as:
3333
- Light absorption (photometric detector)
@@ -36,7 +36,7 @@ The retention times for each analyte are recorded by a detector. The most common
3636

3737
## High performance liquid chromatography (HPLC)
3838

39-
HPLC is the most commonly used technique for separating proteins and metabolites. In HPLC, a high-pressured pump is used to transport a liquid (solvent) containing the molecules of interest through a thin capillary column. The stationary phase is ‘packed’ into the column.
39+
HPLC is the most commonly used technique for separating proteins and metabolites. In HPLC, a high-pressured pump is used to transport a liquid (solvent) containing the molecules of interest through a thin capillary column. The stationary phase is ‘packed’ into the column.
4040

4141
<div class="admonition video">
4242
<p class="admonition-title">**Video**</p>

docs/getting-started/nextflow-get-started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
NextFlow
22
========
33

4-
Nextflow is a workflow system for creating scalable, portable, and reproducible workflows.
5-
It is based on the dataflow programming model, which greatly simplifies the writing of parallel and distributed pipelines,
6-
allowing you to focus on the flow of data and computation.
7-
Nextflow can deploy workflows on a variety of execution platforms, including your local machine, HPC schedulers,
8-
AWS Batch, Azure Batch, Google Cloud Batch, and Kubernetes.
4+
Nextflow is a workflow system for creating scalable, portable, and reproducible workflows.
5+
It is based on the dataflow programming model, which greatly simplifies the writing of parallel and distributed pipelines,
6+
allowing you to focus on the flow of data and computation.
7+
Nextflow can deploy workflows on a variety of execution platforms, including your local machine, HPC schedulers,
8+
AWS Batch, Azure Batch, Google Cloud Batch, and Kubernetes.
99
Additionally, it supports many ways to manage your software dependencies, including Conda, Spack, Docker, Podman, Singularity, and more.[^1]
1010

1111
## Installation
12-
Click [here](https://www.nextflow.io/docs/latest/getstarted.html#installation) to install Nextflow only.
12+
Click [here](https://www.nextflow.io/docs/latest/getstarted.html#installation) to install Nextflow only.
1313
Alternatively click [here](https://nf-co.re/docs/usage/installation) to follow the instructions for using nf-core curated pipelines in Nextflow.
1414

1515
## Ready-made OpenMS nextflow workflows

docs/getting-started/visualize-with-openms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ To filter your data:
9191

9292
1. Select a layer from the **Layers window**.
9393

94-
![display selected layer](/_images/tutorials/toppview/layers-window.png)
94+
![display selected layer](/_images/tutorials/toppview/layers-window.png)
9595

9696
2. Open the **Data filters window** by clicking the tab at the bottom of the screen.
9797

docs/manual/contribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Contribute
33

44
## Reporting Bugs and Issues
55

6-
A list of known issues in the current OpenMS release can be found [here](https://abibuilder.cs.uni-tuebingen.de/archive/openms/Documentation/nightly/html/known_dev_bugs.html).
6+
A list of known issues in the current OpenMS release can be found [here](https://abibuilder.cs.uni-tuebingen.de/archive/openms/Documentation/nightly/html/known_dev_bugs.html).
77
Please check if your OpenMS version matches the current version and if the bug has already been reported.
88

99
In order to report a new bug, please create a [GitHub issue](manual/contribute.md#Write and Label GitHub Issues) or [contact us](/about/communication.md).

docs/manual/contribute/openms-git-workflow.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Naming conventions for the following apply:
1313

1414
* A **local repository** is the repository that lies on your hard drive after cloning.
1515
* A **remote repository** is a repository on a git server such as GitHub.
16-
* A **fork** is a copy of a repository. Forking a repository allows you to freely experiment with changes without
16+
* A **fork** is a copy of a repository. Forking a repository allows you to freely experiment with changes without
1717
affecting the original project.
1818
* **Origin** refers to a remote repository that you have forked. Call this repository `https://github.com/_YOURUSERNAME_/OpenMS`.
1919
* **Upstream** refers to the original remote OpenMS repository. Call this repository `https://github.com/OpenMS/OpenMS`.
@@ -66,7 +66,7 @@ $ git remote -v
6666

6767
```
6868

69-
Fetch changes and new branches from your fork (`origin`) as well as from the central, upstream OpenMS repository by
69+
Fetch changes and new branches from your fork (`origin`) as well as from the central, upstream OpenMS repository by
7070
executing:
7171

7272
```bash
@@ -161,7 +161,7 @@ The above commands:
161161
2. Applies all commits that have been integrated into `develop`.
162162
3. Reapplies your commits on top of the commits integrated into `develop`.
163163

164-
For more information, refer to a [visual explanation of rebasing](http://git-scm.com/book/en/v2/Git-Branching-Rebasing).
164+
For more information, refer to a [visual explanation of rebasing](https://git-scm.com/book/en/v2/Git-Branching-Rebasing).
165165

166166
```{tip}
167167
Do not rebase published branches (e.g. branches that are part of a pull request). If you created a pull request, you

docs/manual/contribute/pull-request-checklist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Pull Request Checklist
44
Before opening a pull request, check the following:
55

66
1. **Does the code build?**
7-
Execute `make` (or your build system's equivalent, e.g., `cmake --build . --target ALL_BUILD --config Release` on
7+
Execute `make` (or your build system's equivalent, e.g., `cmake --build . --target ALL_BUILD --config Release` on
88
Windows).
99
2. **Do all tests pass?**
1010
To check if all tests have passed, execute `ctest`.
@@ -15,7 +15,7 @@ Before opening a pull request, check the following:
1515
It is also recommended to document non-public members and methods.
1616
4. **Does the code introduce changes to the API?**
1717
If the code introduces changes to the API, make sure that the documentation is up-to-date and that the Python bindings
18-
(pyOpenMS) still work. For each change in the C++ API, make a change in the Python API wrapper via
18+
(pyOpenMS) still work. For each change in the C++ API, make a change in the Python API wrapper via
1919
the `pyOpenMS/pxds/` files.
2020
5. **Have you completed regression testing?**
2121
Make sure that you include a test in the test suite for:
@@ -43,5 +43,5 @@ Make sure to:
4343

4444
* **Describe what you have changed in your pull request.**
4545
When opening the pull request, give a detailed overview of what has changed and why. Include a clear rationale for the
46-
changes and add benchmark data if available. See [this request](https://github.com/bitly/dablooms/pull/19) for
46+
changes and add benchmark data if available. See [this request](https://github.com/bitly/dablooms/pull/19) for
4747
an example.

0 commit comments

Comments
 (0)