ranaroussi
Make a wiki of yfinance
With this reply and #886, I think it's a good time to work on a wiki of yfinance. I think this documentation contains
- Classes
- Describe "when to use" simply.
- introduce member functions and data.
- Functions
- Definition and meaning of each parameters within yfinance.
- Type of return objects
- FAQs (solve problems like #266, #336 )
With the docs, newbies like me could spend less time tracing source code. I spent much time reading source code to find out something like "what's difference between download() and history()" and "Which is more efficient when iterating? List of Ticker objs or Tickers obj?"
Last but not least, this is my first version of wiki. Is the template looks ok?
I think it might be great if we have a sketch first, then others could improve contents gradually. I will also contribute it. (slowly and steadily😀)
Wiki is a great idea. I would start at a higher level:
- User guides. E.g. guide to financials data?
- API doc (which you've started)
Also yfinance has a wiki page - can you edit it?
@ValueRaider As far as I see, nope. You might check this wiki permission tutorial for further details. :)
Or you might pull and merge mine into yours as the first step. Everytime anyone does a little bit can raise a issue and remind you to merge.