Skip to content

Commit

Permalink
chore(sdk): Remove the (<type>)from docstring args. (kubeflow#10159)
Browse files Browse the repository at this point in the history
* chore(sdk): Remove the ` (<type>)`from docstring args.

Remote the ` (<type>)` from the docstring args, which are redundant since there are type annotations.

* Trim the unnecessary leading space.
  • Loading branch information
rickyxie0929 authored and stijntratsaertit committed Feb 16, 2024
1 parent 75b92ab commit ad6b291
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions sdk/python/kfp/compiler/read_write_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,12 +175,12 @@ def test(
"""Tests serialization and deserialization consistency and correctness.
Args:
name (str): '{test_group_name}-{test_case_name}'. Useful for print statements/debugging.
test_case (str): Test case name (without file extension).
test_data_dir (str): The directory containing the test case files.
function (str, optional): The function name to compile.
read (bool): Whether the pipeline/component supports deserialization from YAML (IR, except for V1 component YAML back compatability tests).
write (bool): Whether the pipeline/component supports compilation from a Python file.
name: '{test_group_name}-{test_case_name}'. Useful for print statements/debugging.
test_case: Test case name (without file extension).
test_data_dir: The directory containing the test case files.
function: The function name to compile.
read: Whether the pipeline/component supports deserialization from YAML (IR, except for V1 component YAML back compatability tests).
write: Whether the pipeline/component supports compilation from a Python file.
"""
yaml_file = os.path.join(test_data_dir, f'{test_case}.yaml')
py_file = os.path.join(test_data_dir, f'{test_case}.py')
Expand Down

0 comments on commit ad6b291

Please sign in to comment.