Skip to content

Conversation

@AlexisDaniels
Copy link
Collaborator

This pull request concerns the addition of a documentation section + several other details to set up the package

@AlexisDaniels AlexisDaniels added the documentation Improvements or additions to documentation label May 12, 2021
def which_crypto():
print("This function will allow you to choose between BTC, ETH, ADA or DOGE coins")

=======
Copy link
Collaborator Author

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

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.

Copy link

@ToscaBeijaert ToscaBeijaert left a 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 ;)

def which_crypto():
print("This function will allow you to choose between BTC, ETH, ADA or DOGE coins")

=======

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:

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

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

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

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants