Fix/improve documentation for users

[RobertLD]

After spending a fairly considerable amount of time splunking around the library and configuring things to work properly I figured I'd update the documentation so other users will have an easier time understanding how to make use of what is provided here

[RobertLD]

Saw the wf failed Let me check the styling and update

[eirik-thorp]

Hi Robert,

Thank you for your contribution, we will merge the changes to the docstrings once the pipeline succeeds.

As for the issues with styling, you can run flake8 on your end to see the issues, there seems to be some trailing whitespaces in the docstrings that's triggering some errors in the pipeline.

Let me know if you have any further comments.

[RobertLD]

Hi Robert,

Thank you for your contribution, we will merge the changes to the docstrings once the pipeline succeeds.

As for the issues with styling, you can run flake8 on your end to see the issues, there seems to be some trailing whitespaces in the docstrings that's triggering some errors in the pipeline.

Let me know if you have any further comments.

Took your suggestion and ran flake8. Fixed up the whitespace errors it was complaining about

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.06%. Comparing base (78d9499) to head (3660568).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #188      +/-   ##
==========================================
+ Coverage   76.93%   77.06%   +0.13%     
==========================================
  Files         227      227              
  Lines        9180     9180              
==========================================
+ Hits         7063     7075      +12     
+ Misses       2117     2105      -12     

Files with missing lines	Coverage Δ
...lib/data_providers/abstract_price_data_provider.py	34.73% <ø> (ø)

... and 2 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 78d9499...3660568. Read the comment docs.