Skip to content

Commit 99ce4cd

Browse files
committed
update documentation to warn about unstable functions
1 parent 6ffb62b commit 99ce4cd

14 files changed

+310
-237
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
docs/html
2+
docs/.tadoc.org.html
3+
14
*.pyc
25
build
36
*.so

docs/func_groups/cycle_indicators.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,35 @@
11
# Cycle Indicator Functions
22
### HT_DCPERIOD - Hilbert Transform - Dominant Cycle Period
3-
```
3+
NOTE: The ``HT_DCPERIOD`` function has an unstable period.
4+
```python
45
real = HT_DCPERIOD(close)
56
```
67

78
Learn more about the Hilbert Transform - Dominant Cycle Period at [tadoc.org](http://www.tadoc.org/indicator/HT_DCPERIOD.htm).
89
### HT_DCPHASE - Hilbert Transform - Dominant Cycle Phase
9-
```
10+
NOTE: The ``HT_DCPHASE`` function has an unstable period.
11+
```python
1012
real = HT_DCPHASE(close)
1113
```
1214

1315
Learn more about the Hilbert Transform - Dominant Cycle Phase at [tadoc.org](http://www.tadoc.org/indicator/HT_DCPHASE.htm).
1416
### HT_PHASOR - Hilbert Transform - Phasor Components
15-
```
17+
NOTE: The ``HT_PHASOR`` function has an unstable period.
18+
```python
1619
inphase, quadrature = HT_PHASOR(close)
1720
```
1821

1922
Learn more about the Hilbert Transform - Phasor Components at [tadoc.org](http://www.tadoc.org/indicator/HT_PHASOR.htm).
2023
### HT_SINE - Hilbert Transform - SineWave
21-
```
24+
NOTE: The ``HT_SINE`` function has an unstable period.
25+
```python
2226
sine, leadsine = HT_SINE(close)
2327
```
2428

2529
Learn more about the Hilbert Transform - SineWave at [tadoc.org](http://www.tadoc.org/indicator/HT_SINE.htm).
2630
### HT_TRENDMODE - Hilbert Transform - Trend vs Cycle Mode
27-
```
31+
NOTE: The ``HT_TRENDMODE`` function has an unstable period.
32+
```python
2833
integer = HT_TRENDMODE(close)
2934
```
3035

docs/func_groups/math_operators.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
11
# Math Operator Functions
22
### ADD - Vector Arithmetic Add
3-
```
3+
```python
44
real = ADD(high, low)
55
```
66

77
### DIV - Vector Arithmetic Div
8-
```
8+
```python
99
real = DIV(high, low)
1010
```
1111

1212
### MAX - Highest value over a specified period
13-
```
13+
```python
1414
real = MAX(close, timeperiod=30)
1515
```
1616

1717
### MAXINDEX - Index of highest value over a specified period
18-
```
18+
```python
1919
integer = MAXINDEX(close, timeperiod=30)
2020
```
2121

2222
### MIN - Lowest value over a specified period
23-
```
23+
```python
2424
real = MIN(close, timeperiod=30)
2525
```
2626

2727
### MININDEX - Index of lowest value over a specified period
28-
```
28+
```python
2929
integer = MININDEX(close, timeperiod=30)
3030
```
3131

3232
### MINMAX - Lowest and highest values over a specified period
33-
```
33+
```python
3434
min, max = MINMAX(close, timeperiod=30)
3535
```
3636

3737
### MINMAXINDEX - Indexes of lowest and highest values over a specified period
38-
```
38+
```python
3939
minidx, maxidx = MINMAXINDEX(close, timeperiod=30)
4040
```
4141

4242
### MULT - Vector Arithmetic Mult
43-
```
43+
```python
4444
real = MULT(high, low)
4545
```
4646

4747
### SUB - Vector Arithmetic Substraction
48-
```
48+
```python
4949
real = SUB(high, low)
5050
```
5151

5252
### SUM - Summation
53-
```
53+
```python
5454
real = SUM(close, timeperiod=30)
5555
```
5656

docs/func_groups/math_transform.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,76 @@
11
# Math Transform Functions
22
### ACOS - Vector Trigonometric ACos
3-
```
3+
```python
44
real = ACOS(close)
55
```
66

77
### ASIN - Vector Trigonometric ASin
8-
```
8+
```python
99
real = ASIN(close)
1010
```
1111

1212
### ATAN - Vector Trigonometric ATan
13-
```
13+
```python
1414
real = ATAN(close)
1515
```
1616

1717
### CEIL - Vector Ceil
18-
```
18+
```python
1919
real = CEIL(close)
2020
```
2121

2222
### COS - Vector Trigonometric Cos
23-
```
23+
```python
2424
real = COS(close)
2525
```
2626

2727
### COSH - Vector Trigonometric Cosh
28-
```
28+
```python
2929
real = COSH(close)
3030
```
3131

3232
### EXP - Vector Arithmetic Exp
33-
```
33+
```python
3434
real = EXP(close)
3535
```
3636

3737
### FLOOR - Vector Floor
38-
```
38+
```python
3939
real = FLOOR(close)
4040
```
4141

4242
### LN - Vector Log Natural
43-
```
43+
```python
4444
real = LN(close)
4545
```
4646

4747
### LOG10 - Vector Log10
48-
```
48+
```python
4949
real = LOG10(close)
5050
```
5151

5252
### SIN - Vector Trigonometric Sin
53-
```
53+
```python
5454
real = SIN(close)
5555
```
5656

5757
### SINH - Vector Trigonometric Sinh
58-
```
58+
```python
5959
real = SINH(close)
6060
```
6161

6262
### SQRT - Vector Square Root
63-
```
63+
```python
6464
real = SQRT(close)
6565
```
6666

6767
### TAN - Vector Trigonometric Tan
68-
```
68+
```python
6969
real = TAN(close)
7070
```
7171

7272
### TANH - Vector Trigonometric Tanh
73-
```
73+
```python
7474
real = TANH(close)
7575
```
7676

0 commit comments

Comments
 (0)