Skip to content

Commit 0c5b70a

Browse files
committed
Update docstrings
1 parent e64fd59 commit 0c5b70a

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

bittensor_cli/cli.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5810,11 +5810,18 @@ def subnets_set_symbol(
58105810
symbol: str = typer.Argument(help="The symbol to set for your subnet."),
58115811
):
58125812
"""
5813-
Allows the user to update their subnet symbol.
5813+
Allows the user to update their subnet symbol to a different available symbol. The full list of available symbols can be found here:
5814+
[#8CB9E9]https://github.com/opentensor/subtensor/blob/main/pallets/subtensor/src/subnets/symbols.rs#L8[/#8CB9E9]
5815+
58145816
58155817
EXAMPLE
58165818
5817-
[green]$[/green] btcli subnets set-symbol --netuid 1 シ
5819+
[green]$[/green] btcli subnets set-symbol [dark_orange]--netuid 1 シ[/dark_orange]
5820+
5821+
5822+
JSON OUTPUT:
5823+
If --json-output is used, the output will be in the following schema:
5824+
[#AFEFFF]{success: [dark_orange]bool[/dark_orange], message: [dark_orange]str[/dark_orange]}[/#AFEFFF]
58185825
"""
58195826
self.verbosity_handler(quiet, verbose, json_output)
58205827
if len(symbol) > 1:

bittensor_cli/src/commands/subnets/subnets.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2458,7 +2458,12 @@ async def set_symbol(
24582458
prompt: bool = False,
24592459
json_output: bool = False,
24602460
) -> bool:
2461-
"""Set a subtensor's symbol"""
2461+
"""
2462+
Set a subtensor's symbol, given the netuid and symbol.
2463+
2464+
The symbol must be a symbol that subtensor recognizes as available
2465+
(defined in https://github.com/opentensor/subtensor/blob/main/pallets/subtensor/src/subnets/symbols.rs#L8)
2466+
"""
24622467
if not await subtensor.subnet_exists(netuid):
24632468
err = f"Subnet {netuid} does not exist."
24642469
if json_output:

0 commit comments

Comments
 (0)