addisonlynch / iexfinance

Python SDK for IEX Cloud
https://addisonlynch.github.io/iexfinance
Apache License 2.0
648 stars 136 forks source link

Documenting Return Keys #90

Closed jackmoody11 closed 5 years ago

jackmoody11 commented 5 years ago

I was looking through the latest documentation and noticed that a lot of endpoints say something like Returns: Stocks Key Stats endpoint data and doesn't give detail on the return values (without having to go to the iextrading website to look them up through the link).

Is this something that would be beneficial to have on the iexfinance documentation? If so, I would be glad to help do this.

addisonlynch commented 5 years ago

Any PRs helping with the documentation would be greatly appreciated! They could do a much better job of explaining things.

addisonlynch commented 5 years ago

@jackmoody11 I forgot about this issue. I sent you in the wrong direction on documenting the return keys, and I apologize! I'm refactoring iexfinance now on the refactor-docs branch, but anything you see that isn't clear in the documentation after this done, feel free to fix...thanks!