Skip to content

Commit

Permalink
📝 make CLI docs consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
oskvr37 committed Feb 8, 2025
1 parent 9de7e32 commit 5a07a8a
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion tiddl/cli/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"--no-cache", "-nc", is_flag=True, help="Omit Tidal API requests caching."
)
def cli(ctx: Context, verbose: bool, quiet: bool, no_cache: bool):
"""TIDDL - Download Tidal tracks \u266b"""
"""TIDDL - Tidal Downloader \u266b"""
ctx.obj = ContextObj(omit_cache=no_cache)

# latest logs
Expand Down
2 changes: 1 addition & 1 deletion tiddl/cli/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

@click.group("auth")
def AuthGroup():
"""Manage Tidal token"""
"""Manage Tidal token."""


@AuthGroup.command("login")
Expand Down
2 changes: 1 addition & 1 deletion tiddl/cli/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
help="Open the configuration file with the default editor",
)
def ConfigCommand(open: bool):
"""Print path to the configuration file"""
"""Print path to the configuration file."""

click.echo(str(CONFIG_PATH))

Expand Down
2 changes: 1 addition & 1 deletion tiddl/cli/download/fav.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
)
@passContext
def FavGroup(ctx: Context, resource_types: list[ResourceTypeLiteral]):
"""Get your Tidal favorites"""
"""Get your Tidal favorites."""

api = ctx.obj.getApi()

Expand Down
2 changes: 1 addition & 1 deletion tiddl/cli/download/file.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
@click.argument("filename", type=click.File(mode="r"))
@passContext
def FileGroup(ctx: Context, filename: TextIOWrapper):
"""Parse txt or JSON file with urls"""
"""Parse txt or JSON file with urls."""

_, extension = splitext(filename.name)

Expand Down
2 changes: 1 addition & 1 deletion tiddl/cli/download/search.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
@click.argument("query")
@passContext
def SearchGroup(ctx: Context, query: str):
"""Search on Tidal"""
"""Search on Tidal."""

# TODO: give user interactive choice what to select

Expand Down

0 comments on commit 5a07a8a

Please sign in to comment.