schwab-py icon indicating copy to clipboard operation
schwab-py copied to clipboard

`GetQuote.Field` should be a link

Open alexgolec opened this issue 1 year ago • 1 comments

https://schwab-py.readthedocs.io/en/latest/client.html#schwab.client.Client.get_quote

alexgolec avatar Jun 25 '24 23:06 alexgolec

Created by https://github.com/alexgolec/schwab-py/commit/f4e09573932897293c50d38e96ffbca40219005a and not updating the comment there.

If the github workflow for building documentation is changed to sphinx-build -W -n docs/ docs-build (add -n), then the nag message would have said that there was an issue. Otherwise, sphinx-build wasn't making any kind of warning/etc.

I changed it locally on my system, but it still complains, even when it seems correct. Unsure...

schwab/client/base.py:docstring of schwab.client.base.BaseClient.get_quote:7:py:class reference target not found: Quote.Fields

james-coder avatar Jul 13 '24 15:07 james-coder