Skip to content

Commit

Permalink
doc: add missing parameters to docstring (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
hussein-awala authored Feb 26, 2024
1 parent 6d03bda commit 85f929a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions spark_on_k8s/utils/app_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ def kill_app(
namespace (str): Namespace.
pod_name (str): Pod name.
app_id (str): App ID.
should_print (bool, optional): Whether to print logs instead of logging them.
"""
if pod_name is None and app_id is None:
raise ValueError("Either pod_name or app_id must be specified")
Expand Down Expand Up @@ -455,6 +456,7 @@ def spark_app_labels(
Args:
app_name: Name of the Spark application
app_id: ID of the Spark application
extra_labels: Dictionary of extra labels to add to the labels
Returns:
Dictionary of labels for the Spark application resources
Expand Down Expand Up @@ -482,6 +484,7 @@ def create_headless_service_object(
app_id: ID of the Spark application
namespace: Kubernetes namespace to use, defaults to "default"
pod_owner_uid: UID of the pod to use as owner reference for the service
extra_labels: Dictionary of extra labels to add to the service
Returns:
The created headless service for the Spark application
Expand Down

0 comments on commit 85f929a

Please sign in to comment.