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

Fixes AwesomeOscillator Helper Order Of Parameters #8099

Merged

Conversation

AlexCatarino
Copy link
Member

@AlexCatarino AlexCatarino commented Jun 21, 2024

Description

The second and third parameters are fastPeriod and slowPeriod, but we had slowPeriod and fastPeriod, which is inconsistent with the class constructor and other indicators with fastPeriod and slowPeriod parameters.

Related Issue

N/A

Motivation and Context

Consistency and documentation.

Other platforms follow this conversion:

ta.momentum.AwesomeOscillatorIndicator(high: pandas.core.series.Series, low: pandas.core.series.Series, window1: int = 5, window2: int = 34, fillna: bool = False)

https://qtpylib.io/docs/latest/indicators.html#awesome-oscillator

bars['ao'] = bars.awesome_oscillator(weighted=False, fast=5, slow=34])
AO(fast_period: int, slow_period: int, ...)

Requires Documentation Change

No: code gen.

How Has This Been Tested?

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which improves implementation)
  • Performance (non-breaking change which improves performance. Please add associated performance test and results)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Non-functional change (xml comments/documentation/etc)

Checklist:

  • My code follows the code style of this project.
  • I have read the CONTRIBUTING document.
  • All new and existing tests passed.
  • My branch follows the naming convention bug-<issue#>-<description> or feature-<issue#>-<description>

The second and third parameter are `fastPeriod` and `slowPeriod`, but we had `slowPeriod` and `fastPeriod`, which is inconsistent with the class contructor and other indicators with `fastPeriod` and `slowPeriod` parameters.
Copy link
Member

@Martin-Molinero Martin-Molinero left a comment

Choose a reason for hiding this comment

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

Thank you 👍

@Martin-Molinero Martin-Molinero merged commit 9e2b697 into QuantConnect:master Jun 25, 2024
6 of 7 checks passed
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.

None yet

2 participants