Clarify RSI lookback and unstable-period defaults in the docs#748
Open
Whning0513 wants to merge 1 commit into
Open
Clarify RSI lookback and unstable-period defaults in the docs#748Whning0513 wants to merge 1 commit into
Whning0513 wants to merge 1 commit into
Conversation
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
1 participant
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.
Fixes #603.
Also addresses #664.
The function docs already mention lookback periods and unstable functions, but they do not explain two points that keep coming up in issues:
timeperiodis not always the same as the number of raw observations needed before the first output.RSI(timeperiod=14)needs 15 prices because it starts from 14 price changes.get_unstable_period()returns0by default, even for functions documented as unstable, until the caller sets a non-zero unstable period explicitly.This adds those clarifications to the main Function API docs in the README and generated docs pages.