Skip to content

Commit

Permalink
fix: lint docstring err
Browse files Browse the repository at this point in the history
Signed-off-by: machichima <[email protected]>
  • Loading branch information
machichima committed Feb 5, 2025
1 parent 8c826c0 commit d6b752b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
14 changes: 7 additions & 7 deletions plugins/flytekit-spark/flytekitplugins/spark/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ class Spark(object):
Use this to configure a SparkContext for a your task. Task's marked with this will automatically execute
natively onto K8s as a distributed execution of spark
Args:
spark_conf: Dictionary of spark config. The variables should match what spark expects
hadoop_conf: Dictionary of hadoop conf. The variables should match a typical hadoop configuration for spark
executor_path: Python binary executable to use for PySpark in driver and executor.
applications_path: MainFile is the path to a bundled JAR, Python, or R file of the application to execute.
driver_pod: PodTemplate for Spark driver pod
executor_pod: PodTemplate for Spark executor pod
Attributes:
spark_conf (Optional[Dict[str, str]]): Spark configuration dictionary.
hadoop_conf (Optional[Dict[str, str]]): Hadoop configuration dictionary.
executor_path (Optional[str]): Path to the Python binary for PySpark execution.
applications_path (Optional[str]): Path to the main application file.
driver_pod (Optional[PodTemplate]): The pod template for the Spark driver pod.
executor_pod (Optional[PodTemplate]): The pod template for the Spark executor pod.
"""

spark_conf: Optional[Dict[str, str]] = None
Expand Down
2 changes: 0 additions & 2 deletions pydoclint-errors-baseline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -602,8 +602,6 @@ plugins/flytekit-spark/flytekitplugins/spark/models.py
DOC301: Class `SparkJob`: __init__() should not have a docstring; please combine it with the docstring of the class
--------------------
plugins/flytekit-spark/flytekitplugins/spark/task.py
DOC601: Class `Spark`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
DOC603: Class `Spark`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [applications_path: Optional[str], executor_path: Optional[str], hadoop_conf: Optional[Dict[str, str]], spark_conf: Optional[Dict[str, str]]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
DOC601: Class `DatabricksV2`: Class docstring contains fewer class attributes than actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
DOC603: Class `DatabricksV2`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [databricks_conf: Optional[Dict[str, Union[str, dict]]], databricks_instance: Optional[str]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
--------------------
Expand Down

0 comments on commit d6b752b

Please sign in to comment.