search

kieran-mackle / AutoTrader

A Python-based development platform for automated trading systems - from backtesting to optimisation to livetrading.
https://kieran-mackle.github.io/AutoTrader/
GNU General Public License v3.0
945 stars 217 forks source link

building-strategy.md is missing PERIOD: 300 #27

Closed HeisenBug1 closed 2 years ago

HeisenBug1 commented 2 years ago

Describe the bug building-strategy.md in /docs/source/tutorials/ is missing PERIOD: 300 which causes a KeyError when running a test
If someone just follows the tutorial without using the demo repo, then it becomes an issue.
Although, this maybe a very minor issue. I just stumbled on it and thought of letting you guys know.

To Reproduce Steps to reproduce the behavior:

  1. Go to 'building-strategy.md'
  2. Scroll down to 'Strategy Configuration'
  3. Scroll down a little more until you see the code block example for a strategy.yaml
  4. See error

Expected behavior Expected PERIOD: 300 key/value within the example but is missing. But the demo repository has PERIOD: 300 in it's .yaml file

Screenshots ScreenShot

Version of AutoTrader being used N/A (master repository)

Additional context It is also in 'ReadTheDocs.io

kieran-mackle commented 2 years ago

Thank you for pointing this out! Not sure how I didn't copy that specifically when writing the docs. I've updated the docs accordingly.