talipp icon indicating copy to clipboard operation
talipp copied to clipboard

Improve documentation

Open nardew opened this issue 2 years ago • 3 comments

  • for each indicator mention the source
  • generate API documentation

nardew avatar Dec 25 '23 21:12 nardew

Would be nice to understand more clearly what "chaining" is. I don't quite get it just from the readme.

afkjm avatar Feb 09 '24 04:02 afkjm

Hi @afkjm , thanks for the feedback. In the meantime, what exactly is not clear from the example? Output of one indicator simply becomes input of another one.

# Indicator chaining
sma1 = SMA(3)
sma2 = SMA(3, input_indicator = sma1)
sma3 = SMA(3, input_indicator = sma2)

print(f"Chain three moving averages:")
sma1.add([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
print(f"SMA1: {sma1}") # [0, 0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0]
print(f"SMA2: {sma2}") # [0, 0, 0, 0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0]
print(f"SMA3: {sma3}") # [0, 0, 0, 0, 0, 0, 4.0, 5.0, 6.0, 7.0]

nardew avatar Feb 14 '24 19:02 nardew

Thanks, I see now.

afkjm avatar Feb 14 '24 23:02 afkjm

Delivered in #125

nardew avatar Apr 05 '24 19:04 nardew