From 7d6426c4834205e666b5b3dcd0cf4048d0e82607 Mon Sep 17 00:00:00 2001 From: Jamie Date: Sun, 2 May 2021 17:25:45 -0400 Subject: [PATCH] formatting fixes round 2 --- gamestonk_terminal/README.md | 9 ++++++--- gamestonk_terminal/cryptocurrency/README.md | 19 ++++++++++++------- .../cryptocurrency/crypto_controller.py | 9 ++++----- 3 files changed, 22 insertions(+), 15 deletions(-) diff --git a/gamestonk_terminal/README.md b/gamestonk_terminal/README.md index 513e0a375a6..cc52c69aef6 100644 --- a/gamestonk_terminal/README.md +++ b/gamestonk_terminal/README.md @@ -274,10 +274,13 @@ Command|Description Command|Description ------ | ------------ -`load`| load cryptocurrency data from coingecko -`view`| view loaded cryptocurrency data -`trend`| view top 7 coins from coingecko +[coingecko](#https://www.coingecko.com/en)| +`load`| load cryptocurrency data +`view`| view loaded cryptocurrency data +`trend`| view top 7 coins +[coinmarketcap](#http://coinmarketcap.com)| `top` | view top coins from coinmarketcap +[binance](#http://binance.us)| `add` | add binance ticker `book`| get and show order book for symbol `candle`| show candlechart for symbol diff --git a/gamestonk_terminal/cryptocurrency/README.md b/gamestonk_terminal/cryptocurrency/README.md index 12dfbf737b4..33a4aecaa28 100644 --- a/gamestonk_terminal/cryptocurrency/README.md +++ b/gamestonk_terminal/cryptocurrency/README.md @@ -48,10 +48,10 @@ Plot the loaded crypto data. ![crypto_view](https://user-images.githubusercontent.com/25267873/115787452-20889a80-a3ba-11eb-9216-f7fd1ffc98cf.png) ## trend -Print the top 7 trending coins from coingecko ```` usage: trend ```` +Print the top 7 trending coins from coingecko ## top @@ -69,26 +69,29 @@ This command displays the top n cryptocurrencies from coinmarketcap.com. crypto ## select -Select a coin/currency to the current object. Note that in binance, the exchange "ticker" is usually COINCURR, such as BTCEUR -for BTC to EURO. There is no USD, but it uses a coin tethered to the USD (USDT), which is the default. Some symbols -are a combination of coins, as `ETHBTC` is a valid symbol + ```` usage: select [-c --coin] [-q --quote] ```` * -c/--coin Coin to load. If not specified, BTC will be loaded to prevent errors later. * -q/--quote Quote currency. Defaults to `USDT` (which is 1-to-1 with USD) +Select a coin/currency to the current object. Note that in binance, the exchange "ticker" is usually COINCURR, such as BTCEUR +for BTC to EURO. There is no USD, but it uses a coin tethered to the USD (USDT), which is the default. Some symbols +are a combination of coins, as `ETHBTC` is a valid symbol + + Note that the usage `select btc` will also work, as it will add `-c` if not detected. ## book -Gets and shows the order book for the given coin/currency. Shows the cumulative amount of orders. ```` usage: book -l/--limit ```` * -l/--limit Number of orders to get on each side. One of [5,10,20,50,100,500,1000,5000]. Defaults to 100. +Gets and shows the order book for the given coin/currency. Shows the cumulative amount of orders. + ## candle -Show candle chart for loaded coin/currency. (Terminal will quit if coin is not defined). ```` usage: candle [-i --interval] [-l --limit] ```` @@ -97,10 +100,12 @@ usage: candle [-i --interval] [-l --limit] * -l/--limit. Number of candles to get. Defaults to 100. Example output (using 3day interval and 50 candles) +Show candle chart for loaded coin/currency. (Terminal will quit if coin is not defined). + ![im](https://user-images.githubusercontent.com/18151143/116797645-f455d380-aab5-11eb-8dbb-df257425302d.png) ## balance -Shows the current holding balance in your account. ```` usage: balance ```` +Shows the current holding balance in your account. diff --git a/gamestonk_terminal/cryptocurrency/crypto_controller.py b/gamestonk_terminal/cryptocurrency/crypto_controller.py index 7789b0b170a..60a9359631c 100644 --- a/gamestonk_terminal/cryptocurrency/crypto_controller.py +++ b/gamestonk_terminal/cryptocurrency/crypto_controller.py @@ -41,14 +41,13 @@ class CryptoController: self.current_currency = None self.current_df = pd.DataFrame() - @staticmethod - def print_help(cont): + def print_help(self): """Print help""" print("\nCryptocurrency:") print(" help show this menu again") print(" q quit this menu, and shows back to main menu") print(" quit quit to abandon program") - print(f"\nCurrent Coin: {cont.current_coin}") + print(f"\nCurrent Coin: {self.current_coin}") print("") print("Coingecko:") print(" load load cryptocurrency data") @@ -83,7 +82,7 @@ class CryptoController: def call_help(self, _): """Process Help command""" - self.print_help(self) + self.print_help() def call_q(self, _): """Process Q command - quit the menu""" @@ -138,7 +137,7 @@ class CryptoController: def menu(): crypto_controller = CryptoController() - crypto_controller.print_help(None) + crypto_controller.print_help() plt.close("all") while True: # Get input command from user