TA-Lib / ta-lib-python

Python wrapper for TA-Lib (http://ta-lib.org/).
http://ta-lib.github.io/ta-lib-python
Other
9.49k stars 1.74k forks source link

Question on documentation #296

Open wildcolor opened 4 years ago

wildcolor commented 4 years ago

I am very new to ta-lib.

Here is a very stupid question about the documentation. Can anyone direct me where exactly is the detailed documentation? For example, the following shows BBANDS has MA_Type.T3, which means BollingerBands will use EMA instead of SMA. But I can't find the description about BBANDS and MA_Type anywhere.....

upper, middle, lower = talib.BBANDS(close, matype=MA_Type.T3)
mrjbq7 commented 4 years ago

The best documentation is to look at the underlying C library source code:

http://www.ta-lib.org/

This project is just a lightweight wrapper to allow calling the C library from Python.

On Jan 26, 2020, at 9:36 PM, Wei notifications@github.com wrote:

 I am very new to ta-lib. Here is a very stupid question about the documentation. Can anyone direct me where exactly is the detailed documentation? For example, the following shows BBANDS has MA_Type.T3, which means BollingerBands will use EMA instead of SMA. But I can't find the description about BBANDS and MA_Type anywhere.....

upper, middle, lower = talib.BBANDS(close, matype=MA_Type.T3) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.

wildcolor commented 4 years ago

Fair enough to look at the C source. But no detailed documentation, API specification etc? Have to look at the source code?

The best documentation is to look at the underlying C library source code: http://www.ta-lib.org/ This project is just a lightweight wrapper to allow calling the C library from Python. On Jan 26, 2020, at 9:36 PM, Wei @.***> wrote:  I am very new to ta-lib. Here is a very stupid question about the documentation. Can anyone direct me where exactly is the detailed documentation? For example, the following shows BBANDS has MA_Type.T3, which means BollingerBands will use EMA instead of SMA. But I can't find the description about BBANDS and MA_Type anywhere..... upper, middle, lower = talib.BBANDS(close, matype=MA_Type.T3) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.

mrjbq7 commented 4 years ago

You can search for documentation for the Ta-Lib C library, that is applicable. I have tried not to have too much documentation here since this is just a lightweight wrapper.

Maybe that makes it difficult sometimes, not sure.

On Jan 27, 2020, at 6:58 AM, Wei notifications@github.com wrote:

 Fair enough to look at the C source. But no detailed documentation, API specification etc? Have to look at the source code?

The best documentation is to look at the underlying C library source code: http://www.ta-lib.org/ This project is just a lightweight wrapper to allow calling the C library from Python. … On Jan 26, 2020, at 9:36 PM, Wei @.***> wrote:  I am very new to ta-lib. Here is a very stupid question about the documentation. Can anyone direct me where exactly is the detailed documentation? For example, the following shows BBANDS has MA_Type.T3, which means BollingerBands will use EMA instead of SMA. But I can't find the description about BBANDS and MA_Type anywhere..... upper, middle, lower = talib.BBANDS(close, matype=MA_Type.T3) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

wildcolor commented 4 years ago

Thanks for the reply. But I still can't find a decent official description about the talib functions, eg API specification for BBANDS?

Being one of the most well known library, I feel really puzzled to not to see official documentation...

You can search for documentation for the Ta-Lib C library, that is applicable. I have tried not to have too much documentation here since this is just a lightweight wrapper. Maybe that makes it difficult sometimes, not sure. On Jan 27, 2020, at 6:58 AM, Wei @.> wrote:  Fair enough to look at the C source. But no detailed documentation, API specification etc? Have to look at the source code? The best documentation is to look at the underlying C library source code: http://www.ta-lib.org/ This project is just a lightweight wrapper to allow calling the C library from Python. … On Jan 26, 2020, at 9:36 PM, Wei @.> wrote:  I am very new to ta-lib. Here is a very stupid question about the documentation. Can anyone direct me where exactly is the detailed documentation? For example, the following shows BBANDS has MA_Type.T3, which means BollingerBands will use EMA instead of SMA. But I can't find the description about BBANDS and MA_Type anywhere..... upper, middle, lower = talib.BBANDS(close, matype=MA_Type.T3) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe. — You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

mrjbq7 commented 4 years ago

Maybe you’ll have some benefit from looking at these descriptions and links:

http://tadoc.org/

On Jan 27, 2020, at 9:16 AM, Wei notifications@github.com wrote:

 Thanks for the reply. But I still can't find a decent official description about the talib functions, eg API specification for BBANDS?

Being one of the most well known library, I feel really puzzled to not to see official documentation...

You can search for documentation for the Ta-Lib C library, that is applicable. I have tried not to have too much documentation here since this is just a lightweight wrapper. Maybe that makes it difficult sometimes, not sure. … On Jan 27, 2020, at 6:58 AM, Wei @.> wrote:  Fair enough to look at the C source. But no detailed documentation, API specification etc? Have to look at the source code? The best documentation is to look at the underlying C library source code: http://www.ta-lib.org/ This project is just a lightweight wrapper to allow calling the C library from Python. … On Jan 26, 2020, at 9:36 PM, Wei @.> wrote:  I am very new to ta-lib. Here is a very stupid question about the documentation. Can anyone direct me where exactly is the detailed documentation? For example, the following shows BBANDS has MA_Type.T3, which means BollingerBands will use EMA instead of SMA. But I can't find the description about BBANDS and MA_Type anywhere..... upper, middle, lower = talib.BBANDS(close, matype=MA_Type.T3) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe. — You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or unsubscribe.