Skip to content

Add params and docstring to run function in main.star #364

@tedim52

Description

@tedim52

The main.star should contain a doc string that specifies exactly what the possible input args are, which ones are required and which ones are default, and what their descriptions are types are. This will make it easier for users to get onboarded to the ethereum package as they'll know what's parametrizable via a json/yaml file without having to go to package_io or go off solely example inputs, (author consumer divide)

A good example to go off of is the hyperlane package.

Doing this will also make the package render with a nice form input in Kurtosis Cloud like by parsing docstring

Screen Shot 2023-11-19 at 3 20 07 AM

Whereas the ethereum package one looks like this:
Screen Shot 2023-11-19 at 3 21 01 AM

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions