From 829383ff16c14edc39eb13ce124cb17c20b8c2ff Mon Sep 17 00:00:00 2001
From: Marten Chaillet <58044494+McHaillet@users.noreply.github.com>
Date: Wed, 14 Aug 2024 12:31:04 +0200
Subject: [PATCH] add comment to entry_points that tells developers not to use
 line breaks in strings in the snippet

---
 src/pytom_tm/entry_points.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/pytom_tm/entry_points.py b/src/pytom_tm/entry_points.py
index d565ecab..363f9d1a 100644
--- a/src/pytom_tm/entry_points.py
+++ b/src/pytom_tm/entry_points.py
@@ -34,6 +34,8 @@ def pytom_create_mask(argv=None):
 
     argv = _parse_argv(argv)
 
+    # entry_point strings cannot use '\n' characters as this will break the website
+    # snippet that displays the CLI help message
     # ---8<--- [start:create_mask_usage]
 
     parser = argparse.ArgumentParser(
@@ -133,6 +135,8 @@ def pytom_create_template(argv=None):
 
     argv = _parse_argv(argv)
 
+    # entry_point strings cannot use '\n' characters as this will break the website
+    # snippet that displays the CLI help message
     # ---8<--- [start:create_template_usage]
 
     parser = argparse.ArgumentParser(
@@ -284,6 +288,8 @@ def estimate_roc(argv=None):
     argv = _parse_argv(argv)
     from pytom_tm.plotting import plist_quality_gaussian_fit
 
+    # entry_point strings cannot use '\n' characters as this will break the website
+    # snippet that displays the CLI help message
     # ---8<--- [start:estimate_roc_usage]
 
     parser = argparse.ArgumentParser(
@@ -416,6 +422,8 @@ def estimate_roc(argv=None):
 def extract_candidates(argv=None):
     argv = _parse_argv(argv)
 
+    # entry_point strings cannot use '\n' characters as this will break the website
+    # snippet that displays the CLI help message
     # ---8<--- [start:extract_candidates_usage]
 
     parser = argparse.ArgumentParser(
@@ -558,6 +566,8 @@ def match_template(argv=None):
 
     argv = _parse_argv(argv)
 
+    # entry_point strings cannot use '\n' characters as this will break the website
+    # snippet that displays the CLI help message
     # ---8<--- [start:match_template_usage]
 
     parser = argparse.ArgumentParser(
@@ -954,6 +964,8 @@ def match_template(argv=None):
 def merge_stars(argv=None):
     import pandas as pd
 
+    # entry_point strings cannot use '\n' characters as this will break the website
+    # snippet that displays the CLI help message
     # ---8<--- [start:merge_stars_usage]
 
     parser = argparse.ArgumentParser(