Skip to content

Commit

Permalink
Updated the help CLI: punctuations, grammar, and style.
Browse files Browse the repository at this point in the history
  • Loading branch information
CmdP1rx committed May 1, 2024
1 parent 2e3c6fe commit aa1677d
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 60 deletions.
28 changes: 14 additions & 14 deletions core/dbt/cli/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

@dataclass
class dbtRunnerResult:
"""Contains the result of an invocation of the dbtRunner"""
"""Contains the result of an invocation of the dbtRunner."""

success: bool

Expand Down Expand Up @@ -162,7 +162,7 @@ def wrapper(*args, **kwargs):
@p.show_resource_report
def cli(ctx, **kwargs):
"""An ELT tool for managing your SQL transformations and data models.
For more documentation on these commands, visit: docs.getdbt.com
For more documentation on these commands, visit: docs.getdbt.com.
"""


Expand Down Expand Up @@ -193,7 +193,7 @@ def cli(ctx, **kwargs):
@requires.runtime_config
@requires.manifest
def build(ctx, **kwargs):
"""Run all seeds, models, snapshots, and tests in DAG order"""
"""Run all seeds, models, snapshots, and tests in DAG order."""
from dbt.task.build import BuildTask

task = BuildTask(
Expand Down Expand Up @@ -221,7 +221,7 @@ def build(ctx, **kwargs):
@requires.unset_profile
@requires.project
def clean(ctx, **kwargs):
"""Delete all folders in the clean-targets list (usually the dbt_packages and target directories.)"""
"""Delete all folders in the clean-targets list (usually the dbt_packages and target directories)."""
from dbt.task.clean import CleanTask

task = CleanTask(ctx.obj["flags"], ctx.obj["project"])
Expand All @@ -236,7 +236,7 @@ def clean(ctx, **kwargs):
@click.pass_context
@global_flags
def docs(ctx, **kwargs):
"""Generate or serve the documentation website for your project"""
"""Generate or serve the documentation website for your project."""


# dbt docs generate
Expand All @@ -261,7 +261,7 @@ def docs(ctx, **kwargs):
@requires.runtime_config
@requires.manifest(write=False)
def docs_generate(ctx, **kwargs):
"""Generate the documentation website for your project"""
"""Generate the documentation website for your project."""
from dbt.task.docs.generate import GenerateTask

task = GenerateTask(
Expand Down Expand Up @@ -291,7 +291,7 @@ def docs_generate(ctx, **kwargs):
@requires.project
@requires.runtime_config
def docs_serve(ctx, **kwargs):
"""Serve the documentation website for your project"""
"""Serve the documentation website for your project."""
from dbt.task.docs.serve import ServeTask

task = ServeTask(
Expand Down Expand Up @@ -330,7 +330,7 @@ def docs_serve(ctx, **kwargs):
@requires.manifest
def compile(ctx, **kwargs):
"""Generates executable SQL from source, model, test, and analysis files. Compiled SQL files are written to the
target/ directory."""
target/directory."""
from dbt.task.compile import CompileTask

task = CompileTask(
Expand Down Expand Up @@ -494,7 +494,7 @@ def init(ctx, **kwargs):
@requires.runtime_config
@requires.manifest
def list(ctx, **kwargs):
"""List the resources in your project"""
"""List the resources in your project."""
from dbt.task.list import ListTask

task = ListTask(
Expand Down Expand Up @@ -530,7 +530,7 @@ def list(ctx, **kwargs):
@requires.runtime_config
@requires.manifest(write_perf_info=True)
def parse(ctx, **kwargs):
"""Parses the project and provides information on performance"""
"""Parses the project and provides information on performance."""
# manifest generation and writing happens in @requires.manifest
return ctx.obj["manifest"], True

Expand Down Expand Up @@ -721,7 +721,7 @@ def seed(ctx, **kwargs):
@requires.runtime_config
@requires.manifest
def snapshot(ctx, **kwargs):
"""Execute snapshots defined in your project"""
"""Execute snapshots defined in your project."""
from dbt.task.snapshot import SnapshotTask

task = SnapshotTask(
Expand All @@ -740,7 +740,7 @@ def snapshot(ctx, **kwargs):
@click.pass_context
@global_flags
def source(ctx, **kwargs):
"""Manage your project's sources"""
"""Manage your project's sources."""


# dbt source freshness
Expand All @@ -763,7 +763,7 @@ def source(ctx, **kwargs):
@requires.runtime_config
@requires.manifest
def freshness(ctx, **kwargs):
"""check the current freshness of the project's sources"""
"""Check the current freshness of the project's sources."""
from dbt.task.freshness import FreshnessTask

task = FreshnessTask(
Expand Down Expand Up @@ -803,7 +803,7 @@ def freshness(ctx, **kwargs):
@requires.runtime_config
@requires.manifest
def test(ctx, **kwargs):
"""Runs tests on data in deployed models. Run this after `dbt run`"""
"""Runs tests on data in deployed models. Run this after `dbt run`."""
from dbt.task.test import TestTask

task = TestTask(
Expand Down
Loading

0 comments on commit aa1677d

Please sign in to comment.