-
Notifications
You must be signed in to change notification settings - Fork 0
Documentation #2
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
base: main
Are you sure you want to change the base?
Conversation
Now I can import the package and use the functions independently
Crypto_bot_pkg/crypto_selection.py
Outdated
| def which_crypto(): | ||
| print("This function will allow you to choose between BTC, ETH, ADA or DOGE coins") | ||
|
|
||
| ======= |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here is where the assignment from this week begins - all other file updates were to allow the installation of the package
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could add documentation to the which_crypto() after you've made the function of course.
ToscaBeijaert
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was not that much to say. I guess just start writing the functions ;)
Crypto_bot_pkg/crypto_selection.py
Outdated
| def which_crypto(): | ||
| print("This function will allow you to choose between BTC, ETH, ADA or DOGE coins") | ||
|
|
||
| ======= |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could add documentation to the which_crypto() after you've made the function of course.
| @@ -0,0 +1,17 @@ | |||
| class crypto_bot: | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
again, make it Crypto_bot
|
|
||
| def which_crypto(): | ||
| """ | ||
| This is function 1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
once you've made the function, don't forget to add parameters to the documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes I'd second that!
|
|
||
| def trade_bot(): | ||
| """ | ||
| This is function 2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest that you briefly explain what the function does in the documentation as well.
This vignette was created using Jupyter notebooks. It contains information about how to use the GUI and some details about the RSI.
This pull request concerns the addition of a documentation section + several other details to set up the package