From 7ff2e1086677e1b4ace5717557258b4a1650e870 Mon Sep 17 00:00:00 2001 From: riyasng12 Date: Fri, 19 Jan 2024 11:06:55 +0530 Subject: [PATCH] docs: update doc string in main.star --- main.star | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/main.star b/main.star index dbbf0cb..cb284ec 100644 --- a/main.star +++ b/main.star @@ -13,22 +13,22 @@ 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 (dict, optional): A dict containing data for relay chain config. + relaychain (json, optional): A json object containing data for relay chain config. - name (string): Name of relay chain. - - nodes (list): A list of dicts containing node details. + - 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 (list, optional): A list containing data for para chain config. Each item in the list is a dict containing the following: + parachains (json, optional): A json object containing data for para chain config. Each item in the list has the following: - name (string): Name of para chain. - - nodes (list): A list of dicts containing node details. + - 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. Returns: - service_details (dict): Service details containing information about relay chains, parachains, and Prometheus. + service_details (json): Service details containing information about relay chains, parachains, and Prometheus. """ service_details = run_polkadot_setup(plan, chain_type, relaychain, parachains, explorer) return service_details @@ -40,22 +40,22 @@ def run_polkadot_setup(plan, chain_type, relaychain, parachains, explorer): Args: chain_type (string): The type of chain (local, testnet or mainnet). Default is local. - relaychain (dict): A dict containing data for relay chain config. + relaychain (json): A json object containing data for relay chain config. - name (string): Name of relay chain. - - node (dict): A dict of node details. + - node (json): A json object of 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 (list): A list 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. - - node (dict): A dict of node details. + - node (json): A json object of 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): A boolean value indicating whether to enable polkadot js explorer or not. Returns: - dict: Service details containing information about relay chains, parachains, and Prometheus. + service_details (json): Service details containing information about relay chains, parachains, and Prometheus. """ chain_type, relaychain, parachains = utils.convert_to_lowercase(chain_type, relaychain, parachains)