Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add comment to entry_points that tells developers not to use line bre… #219

Merged
merged 2 commits into from
Aug 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ -560,6 +568,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 @@ -956,6 +966,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