Skip to content

Commit

Permalink
Merge pull request #185 from leoporoli/main
Browse files Browse the repository at this point in the history
docs: removing `optional` identifier in arguments type definitions for the run function docstring
  • Loading branch information
Mr-Nobody21 authored Jan 20, 2024
2 parents 40fe658 + e6823e3 commit 36fe45b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions main.star
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

0 comments on commit 36fe45b

Please sign in to comment.