Merge pull request #115 from briancappello/update_docs

update documentation to warn about unstable functions

.gitignore

@@ -1,3 +1,6 @@
+docs/html
+docs/.tadoc.org.html
+
 *.pyc
 build
 *.so

docs/func_groups/cycle_indicators.md

@@ -1,30 +1,35 @@
 # Cycle Indicator Functions
 ### HT_DCPERIOD - Hilbert Transform - Dominant Cycle Period
-```
+NOTE: The ``HT_DCPERIOD`` function has an unstable period.  
+```python
 real = HT_DCPERIOD(close)
 ```
 
 Learn more about the Hilbert Transform - Dominant Cycle Period at [tadoc.org](http://www.tadoc.org/indicator/HT_DCPERIOD.htm).  
 ### HT_DCPHASE - Hilbert Transform - Dominant Cycle Phase
-```
+NOTE: The ``HT_DCPHASE`` function has an unstable period.  
+```python
 real = HT_DCPHASE(close)
 ```
 
 Learn more about the Hilbert Transform - Dominant Cycle Phase at [tadoc.org](http://www.tadoc.org/indicator/HT_DCPHASE.htm).  
 ### HT_PHASOR - Hilbert Transform - Phasor Components
-```
+NOTE: The ``HT_PHASOR`` function has an unstable period.  
+```python
 inphase, quadrature = HT_PHASOR(close)
 ```
 
 Learn more about the Hilbert Transform - Phasor Components at [tadoc.org](http://www.tadoc.org/indicator/HT_PHASOR.htm).  
 ### HT_SINE - Hilbert Transform - SineWave
-```
+NOTE: The ``HT_SINE`` function has an unstable period.  
+```python
 sine, leadsine = HT_SINE(close)
 ```
 
 Learn more about the Hilbert Transform - SineWave at [tadoc.org](http://www.tadoc.org/indicator/HT_SINE.htm).  
 ### HT_TRENDMODE - Hilbert Transform - Trend vs Cycle Mode
-```
+NOTE: The ``HT_TRENDMODE`` function has an unstable period.  
+```python
 integer = HT_TRENDMODE(close)
 ```
 

docs/func_groups/math_operators.md

@@ -1,56 +1,56 @@
 # Math Operator Functions
 ### ADD - Vector Arithmetic Add
-```
+```python
 real = ADD(high, low)
 ```
 
 ### DIV - Vector Arithmetic Div
-```
+```python
 real = DIV(high, low)
 ```
 
 ### MAX - Highest value over a specified period
-```
+```python
 real = MAX(close, timeperiod=30)
 ```
 
 ### MAXINDEX - Index of highest value over a specified period
-```
+```python
 integer = MAXINDEX(close, timeperiod=30)
 ```
 
 ### MIN - Lowest value over a specified period
-```
+```python
 real = MIN(close, timeperiod=30)
 ```
 
 ### MININDEX - Index of lowest value over a specified period
-```
+```python
 integer = MININDEX(close, timeperiod=30)
 ```
 
 ### MINMAX - Lowest and highest values over a specified period
-```
+```python
 min, max = MINMAX(close, timeperiod=30)
 ```
 
 ### MINMAXINDEX - Indexes of lowest and highest values over a specified period
-```
+```python
 minidx, maxidx = MINMAXINDEX(close, timeperiod=30)
 ```
 
 ### MULT - Vector Arithmetic Mult
-```
+```python
 real = MULT(high, low)
 ```
 
 ### SUB - Vector Arithmetic Substraction
-```
+```python
 real = SUB(high, low)
 ```
 
 ### SUM - Summation
-```
+```python
 real = SUM(close, timeperiod=30)
 ```
 

docs/func_groups/math_transform.md

@@ -1,76 +1,76 @@
 # Math Transform Functions
 ### ACOS - Vector Trigonometric ACos
-```
+```python
 real = ACOS(close)
 ```
 
 ### ASIN - Vector Trigonometric ASin
-```
+```python
 real = ASIN(close)
 ```
 
 ### ATAN - Vector Trigonometric ATan
-```
+```python
 real = ATAN(close)
 ```
 
 ### CEIL - Vector Ceil
-```
+```python
 real = CEIL(close)
 ```
 
 ### COS - Vector Trigonometric Cos
-```
+```python
 real = COS(close)
 ```
 
 ### COSH - Vector Trigonometric Cosh
-```
+```python
 real = COSH(close)
 ```
 
 ### EXP - Vector Arithmetic Exp
-```
+```python
 real = EXP(close)
 ```
 
 ### FLOOR - Vector Floor
-```
+```python
 real = FLOOR(close)
 ```
 
 ### LN - Vector Log Natural
-```
+```python
 real = LN(close)
 ```
 
 ### LOG10 - Vector Log10
-```
+```python
 real = LOG10(close)
 ```
 
 ### SIN - Vector Trigonometric Sin
-```
+```python
 real = SIN(close)
 ```
 
 ### SINH - Vector Trigonometric Sinh
-```
+```python
 real = SINH(close)
 ```
 
 ### SQRT - Vector Square Root
-```
+```python
 real = SQRT(close)
 ```
 
 ### TAN - Vector Trigonometric Tan
-```
+```python
 real = TAN(close)
 ```
 
 ### TANH - Vector Trigonometric Tanh
-```
+```python
 real = TANH(close)
 ```