Document back_adjust and progress parameters in download()#2870
Open
furqan-khan07 wants to merge 1 commit into
Open
Document back_adjust and progress parameters in download()#2870furqan-khan07 wants to merge 1 commit into
back_adjust and progress parameters in download()#2870furqan-khan07 wants to merge 1 commit into
Conversation
Collaborator
|
back_adjust should be deprecated for future removal. It's just duplicating auto_adjust |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
download()docstring documents every keyword argument except two that are part of its public signature:back_adjust(defaults toFalse)progress(defaults toTrue)Since the docs site is generated from these docstrings, both parameters are currently missing from the published API reference for
yf.download(), even though users can and do pass them.This PR adds entries for both, following the existing format and placement (
back_adjustnext to its siblingauto_adjust,progressalongside the other download-behaviour flags).Changes
yfinance/multi.py: documentback_adjustandprogressindownload().Docs-only change — no functional impact.