Skip to content

Commit

Permalink
add comment to entry_points that tells developers not to use line bre…
Browse files Browse the repository at this point in the history
…aks in strings in the snippet
  • Loading branch information
McHaillet authored Aug 14, 2024
1 parent e28e155 commit 829383f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/pytom_tm/entry_points.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down

0 comments on commit 829383f

Please sign in to comment.