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.

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

Doc: Updates WalletBalanceCommand docstring #1716

Merged
merged 2 commits into from
Feb 23, 2024
Merged
Changes from all commits
Commits
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
21 changes: 19 additions & 2 deletions bittensor/commands/wallets.py
Original file line number Diff line number Diff line change
Expand Up @@ -727,11 +727,28 @@ class WalletBalanceCommand:
Optional arguments:
None. The command uses the wallet and subtensor configurations to fetch balance data.

Example usage::
Example usages:

- To display the balance of a single wallet, use the command with the `--wallet.name` argument to specify the wallet name:

```
btcli w balance --wallet.name WALLET
```

- Alternatively, you can invoke the command without specifying a wallet name, which will prompt you to enter the wallets path:

```
btcli w balance
```

- To display the balances of all wallets, use the `--all` argument:

btcli wallet balance
```
btcli w balance --all
```

Note:
When using `btcli`, `w` is used interchangeably with `wallet`. You may use either based on your preference for brevity or clarity.
This command is essential for users to monitor their financial status on the Bittensor network.
It helps in keeping track of assets and ensuring the wallet's financial health.
"""
Expand Down