Skip to content

Commit

Permalink
feat: Improve help for typer app and add emoji in main help diagnostic
Browse files Browse the repository at this point in the history
in main.
  • Loading branch information
gkapfham committed Sep 7, 2022
1 parent 8187f00 commit 23b23ec
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion gatorgrade/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,17 @@
from gatorgrade.output.output import run_checks

# create an app for the Typer-based CLI
app = typer.Typer(add_completion=False)

# define the emoji that will be prepended to the help message
gatorgrade_emoji = "🐊"

# create a Typer app that
# --> does not support completion
# --> has a specified help message with an emoji
app = typer.Typer(
add_completion=False,
help=f"{gatorgrade_emoji} Run the GatorGrader checks in the specified gatorgrade.yml file.",
)

# create a default console for printing with rich
console = Console()
Expand Down

0 comments on commit 23b23ec

Please sign in to comment.