Skip to content

Commit a28e63b

Browse files
committed
tidy up cli help text declarations
1 parent 7de9ab7 commit a28e63b

File tree

5 files changed

+23
-10
lines changed

5 files changed

+23
-10
lines changed

airbyte_cdk/cli/airbyte_cdk/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949

5050

5151
@click.group(
52-
help=__doc__.replace("\n", "\n\n"), # Workaround to format help text correctly
52+
help=__doc__.replace("\n", "\n\n"), # Render docstring as help text (markdown)
5353
invoke_without_command=True,
5454
)
5555
@click.option(

airbyte_cdk/cli/airbyte_cdk/_connector.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,10 @@
8888
'''
8989

9090

91-
@click.group(name="connector")
91+
@click.group(
92+
name="connector",
93+
help=__doc__.replace("\n", "\n\n"), # Render docstring as help text (markdown)
94+
)
9295
def connector_cli_group() -> None:
9396
"""Connector related commands."""
9497
pass

airbyte_cdk/cli/airbyte_cdk/_image.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
# Copyright (c) 2025 Airbyte, Inc., all rights reserved.
2-
"""Docker image commands."""
2+
"""Docker image commands.
3+
4+
Coming soon.
5+
6+
This module is planned to provide a command line interface (CLI) for building
7+
Docker images for Airbyte CDK connectors.
8+
"""
39

410
import click
511

612

7-
@click.group(name="image")
13+
@click.group(
14+
name="image",
15+
help=__doc__.replace("\n", "\n\n"), # Render docstring as help text (markdown)
16+
)
817
def image_cli_group() -> None:
918
"""Docker image commands."""
1019
pass

airbyte_cdk/cli/airbyte_cdk/_manifest.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@
77
Airbyte CDK manifests.
88
"""
99

10-
import click
10+
import rich_click as click
1111

1212

13-
@click.group(name="manifest")
14-
def manifest_cli_group(
15-
help=__doc__,
16-
) -> None:
13+
@click.group(
14+
name="manifest",
15+
help=__doc__.replace("\n", "\n\n"), # Render docstring as help text (markdown)
16+
)
17+
def manifest_cli_group() -> None:
1718
"""Manifest related commands."""
1819
pass
1920

airbyte_cdk/cli/airbyte_cdk/_secrets.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
@click.group(
3232
name="secrets",
33-
help=__doc__.replace("\n", "\n\n"),
33+
help=__doc__.replace("\n", "\n\n"), # Render docstring as help text (markdown)
3434
)
3535
def secrets_cli_group() -> None:
3636
"""Secret management commands."""

0 commit comments

Comments
 (0)