Skip to content

Commit 5595a8b

Browse files
committed
style(docs): fix docstrings in tasks
1 parent d9a87c7 commit 5595a8b

6 files changed

Lines changed: 9 additions & 9 deletions

File tree

tasks/cleans.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,4 +134,4 @@ def all(_: Context) -> None:
134134

135135
@task(pre=[all, sources, projects])
136136
def reset(_: Context) -> None:
137-
"""Run all tools, folders, and sources tasks."""
137+
"""Run all tools, folders, sources, and projects tasks."""

tasks/containers.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ def compose(ctx: Context) -> None:
2222

2323
@task(pre=[packages.build])
2424
def build(ctx: Context, tag: str = IMAGE_TAG) -> None:
25-
"""Build the container image with the given tag."""
25+
"""Build the container image."""
2626
ctx.run(f"docker build --tag={ctx.project.name}:{tag} .")
2727

2828

2929
@task
3030
def run(ctx: Context, tag: str = IMAGE_TAG) -> None:
31-
"""Run the container image with the given tag."""
31+
"""Run the container image."""
3232
ctx.run(f"docker run --rm {ctx.project.name}:{tag}")
3333

3434

tasks/docs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@
1717

1818
@task
1919
def serve(ctx: Context, format: str = DOC_FORMAT, port: int = 8088) -> None:
20-
"""Serve the API docs with pdoc using the given format and computer port."""
20+
"""Serve the API docs with pdoc."""
2121
ctx.run(f"poetry run pdoc --docformat={format} --port={port} src/{ctx.project.name}")
2222

2323

2424
@task
2525
def api(ctx: Context, format: str = DOC_FORMAT, output_dir: str = OUTPUT_DIR) -> None:
26-
"""Document the API with pdoc using the given format and output directory."""
26+
"""Generate the API docs with pdoc."""
2727
ctx.run(
2828
f"poetry run pdoc --docformat={format} --output-directory={output_dir} src/{ctx.project.name}"
2929
)

tasks/mlflow.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010

1111
@task
1212
def doctor(ctx: Context) -> None:
13-
"""Run mlflow doctor to diagnose issues."""
13+
"""Run mlflow doctor."""
1414
ctx.run("poetry run mlflow doctor")
1515

1616

1717
@task
1818
def serve(
1919
ctx: Context, host: str = "127.0.0.1", port: str = "5000", backend_uri: str = "./mlruns"
2020
) -> None:
21-
"""Start mlflow server with the given host, port, and backend uri."""
21+
"""Start the mlflow server."""
2222
ctx.run(
2323
f"poetry run mlflow server --host={host} --port={port} --backend-store-uri={backend_uri}"
2424
)

tasks/packages.py

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

1717
@task(pre=[cleans.dist])
1818
def build(ctx: Context, format: str = BUILD_FORMAT) -> None:
19-
"""Build a python package with the given format."""
19+
"""Build the python package."""
2020
ctx.run(f"poetry build --format={format}")
2121

2222

tasks/projects.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def environment(ctx: Context) -> None:
4242

4343
@task
4444
def run(ctx: Context, job: str) -> None:
45-
"""Run an mlflow project from MLproject file."""
45+
"""Run an mlflow project from the MLproject file."""
4646
ctx.run(
4747
f"mlflow run --experiment-name={ctx.project.name}"
4848
f" --run-name={job.capitalize()} -P conf_file=confs/{job}.yaml ."

0 commit comments

Comments
 (0)