Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Sphinx docs #2120

Merged
merged 1 commit into from
Nov 16, 2024

Conversation

ValueRaider
Copy link
Collaborator

Reorganise new documentation, add some missing content.

@ericpien can you sanity-check this? The changes are mostly AI - lots of warnings but seems to work, not sure how the Action will cope.

Copy link

@paulmcq paulmcq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in doc/source/advanced/caching.rst line 48, suggest being a little less terse:
To reduce the number of requests to Yahoo servers, yfinance caches some data locally: timezones to localize dates, and the cookie & crumb. The cache location depends on the OS:

@ValueRaider ValueRaider marked this pull request as draft November 9, 2024 21:58
@ericpien
Copy link
Contributor

hey @ValueRaider I noticed this was converted to draft. Should I still review as is?

I see the vision in 1. Splitting out Ticker to underlying functions and 2. Changing the class.rst template but the implementation will take some work to rid of the warnings and unnecessary methods like __dict__ and duplicate __init__.

@ValueRaider ValueRaider marked this pull request as ready for review November 14, 2024 20:25
@ValueRaider
Copy link
Collaborator Author

ValueRaider commented Nov 14, 2024

I misuse draft state - we really need another state to mean ready for review but probably not merge.

All warnings fixed.

Add minimal quick-start to root
Simplify examples/ticker.py
Separate Ticker API into more groups in reference/index.rst
Fix some duplicate labels
@ValueRaider ValueRaider merged commit a9e70b4 into ranaroussi:dev-documented Nov 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants