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

Market API documentation #2358

Open
dgilmore33 opened this issue Mar 13, 2025 · 2 comments
Open

Market API documentation #2358

dgilmore33 opened this issue Mar 13, 2025 · 2 comments

Comments

@dgilmore33
Copy link

From the api docs, the market link leads to an unhelpful autogenerated stub. The useful class information is contained in the market class description, which I think would be a better ref for the link

@ValueRaider
Copy link
Collaborator

The link URLs are correct, the real issue is Market class doesn't have docstrings.

(Also market is listed twice, should be once)

@dgilmore33
Copy link
Author

I'm going to argue that the links should be changed.

As it stands, from

https://yfinance-python.org/reference/index.html

I can click to

https://yfinance-python.org/reference/api/yfinance.Market.html#yfinance.Market

Which produces the docstring-less stub. However, the UI indicates that the Market stub is under the Market branch of the reference.

image

I think that the link should lead to

https://yfinance-python.org/reference/yfinance.market.html

Which will have the docstrings (currently a stub) accessible from there.

I'll fork the repo, see if I can provide a version of what I'm thinking, and submit more evidence from a new UI.

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

No branches or pull requests

2 participants