Need to add examples for plot_candlestick_chart function in pyalgotrading/utils/func.py

[Blackfury7]

I am trying to use this function to plot candlesticks for my dataframe. But the format of arguments is not mentioned properly. First I was stuck at plot_type argument. To understand it I had to find the code in the repo where it was defined. Now ,I am finding it difficult to understand the format of indicators required for this function.

So, there is need of examples and additional information on arguments.

[Blackfury7]

I would like to work on this. Can you assign this to me? @pushpakdagade @guanidene

[pushpakdagade]

Hi @Blackfury7, I didn't get your exact problem here. Kindly elaborate. Alternatively, you are free to raise a PR and if it adds value, I will merge it.

[Blackfury7]

I wanted to plot the candlestick plot of Dataframe data (HIGH, LOW, CLOSE, OPEN) and 'indicator'. I tried using the "plot_candlestick_chart" function in pyalgotrading/utils/func.py, but the datatypes and formats of the arguments of the "plot_candlestick_chart" function were not mentioned clearly in the documentation. There were no examples also, like this type of data this function takes as argument. I faced difficulty in using the "plot_candlestick_chart".

Then I had to look into the code base of pyalgotrading to properly understand the "plot_candlestick_chart" function and use it.

So, there is requirement of few examples in the documentation to show clarity on how to use this plot_candlestick_chart or other plot algorithms in pyalgotrading.

[pushpakdagade]

@Blackfury7 are you open to making contributions to help create doc here? We'll support you for the same.