Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: removing optional identifier in arguments type definitions for the run function docstring #185

Merged
merged 3 commits into from
Jan 20, 2024
Merged

docs: removing optional identifier in arguments type definitions for the run function docstring #185

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f946b6a
replacing package name
leoporoli Jan 19, 2024
234ab87
removing optional
leoporoli Jan 19, 2024
e6823e3
revert change in package name
leoporoli Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions main.star
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ def run(plan, chain_type = "local", relaychain = None, parachains = None, explor

Args:
chain_type (string): The type of chain (local, testnet or mainnet). Default is local.
relaychain (json, optional): A json object containing data for relay chain config.
relaychain (json): A json object containing data for relay chain config.
- name (string): Name of relay chain.
- nodes (json): A json object containing node details.
- name (string): Name of node.
- node_type (string): Type of node.
- prometheus (bool): Boolean value to enable metrics for a given node.
parachains (json, optional): A json object containing data for para chain config. Each item in the list has the following:
parachains (json): A json object containing data for para chain config. Each item in the list has the following:
- name (string): Name of para chain.
- nodes (json): A json object containing node details.
- name (string): Name of node.
- node_type (string): Type of node.
- prometheus (bool): Boolean value to enable metrics for a given node.
explorer (bool, optional): A boolean value indicating whether to enable polkadot js explorer or not.
explorer (bool): A boolean value indicating whether to enable polkadot js explorer or not.

Returns:
service_details (json): Service details containing information about relay chains, parachains, and Prometheus.
Expand Down
Loading