Skip to content

Commit eac9148

Browse files
authored
chore: added a doc string for better args (ethereum#552)
This should improve the doc string for the arguments provided to Kurtosis; I am not sure how to test this easily in the UI before merging this but I ran the linter on this and the string is valid <img width="894" alt="image" src="https://github.com/kurtosis-tech/ethereum-package/assets/6670312/adea27d2-814b-4008-bb02-c72c40533094"> this is how it currently looks like; after this gets added the args will have the string description given in this PR <img width="894" alt="image" src="https://github.com/kurtosis-tech/ethereum-package/assets/6670312/6fce937f-8203-4329-a978-3011f76ea15c"> this pure YAML/JSON field will still expect something like ``` args: participants: ```
1 parent 99242d6 commit eac9148

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

main.star

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ PATH_TO_PARSED_BEACON_STATE = "/genesis/output/parsedBeaconState.json"
5252

5353

5454
def run(plan, args={}):
55+
"""Launches an arbitrarily complex ethereum testnet based on the arguments provided
56+
57+
Args:
58+
arg: A YAML or JSON argument to configure the network; example https://github.com/kurtosis-tech/ethereum-package/blob/main/network_params.yaml
59+
"""
60+
5561
args_with_right_defaults = input_parser.input_parser(plan, args)
5662

5763
num_participants = len(args_with_right_defaults.participants)

0 commit comments

Comments
 (0)