Skip to content

feat: Remove sma_periods default value for StarcBands#343

Merged
LeeDongGeon1996 merged 3 commits intofacioquo:mainfrom
LeeDongGeon1996:feature/remove-default-StarcBands
Jan 21, 2024
Merged

feat: Remove sma_periods default value for StarcBands#343
LeeDongGeon1996 merged 3 commits intofacioquo:mainfrom
LeeDongGeon1996:feature/remove-default-StarcBands

Conversation

@LeeDongGeon1996
Copy link
Collaborator

@LeeDongGeon1996 LeeDongGeon1996 commented Jan 18, 2024 •
edited
Loading

Description

  • Remove sma_periods default value for StarcBands

Checklist

  • My code follows the existing style, code structure, and naming taxonomy
  • I have commented my code, particularly in hard-to-understand areas
  • I have performed a self-review of my own code and included any verifying manual calculations
  • I have added or updated unit tests that prove my fix is effective or that my feature works, and achieves sufficient code coverage. New and existing unit tests pass locally and in the build (below) with my changes
  • My changes generate no new warnings and running code analysis does not produce any issues
  • I have added or run the performance tests that depict optimal execution times
  • I have made corresponding changes to the documentation

@LeeDongGeon1996
Copy link
Collaborator Author

LeeDongGeon1996 commented Jan 18, 2024 •
edited
Loading

@DaveSkender I'm worried about this can affect on user's side, if there's someone using sma_periods default value. Do we need to show only warning message in this version(v1.2.0)? And remove default value the next version(v1.3.0)?

@DaveSkender
Copy link
Member

DaveSkender commented Jan 18, 2024

@DaveSkender I'm worried about this can affect on user's side, if there's someone using sma_periods default value. Do we need to show only warning message in this version(v1.2.0)? And remove default value the next version(v1.3.0)?

In these cases, to avoid a breaking change, C# has this convention to mark something as obsolete so it'll still work, but will produce a compiler warning, so I can hold off on fully removing the code until the next major vN.0.0 version where I'll be more explicit about documenting breaking changes in the release notes.

https://github.com/DaveSkender/Stock.Indicators/blob/eddb511ac060faf6270fa40c97253cdc509f08d5/src/_common/ObsoleteV2.cs#L53-L59

LeeDongGeon1996
LeeDongGeon1996 commented Jan 20, 2024
View reviewed changes
@LeeDongGeon1996 LeeDongGeon1996 marked this pull request as ready for review January 20, 2024 10:00
@LeeDongGeon1996 LeeDongGeon1996 mentioned this pull request Jan 20, 2024
Closed
17 tasks
@LeeDongGeon1996 LeeDongGeon1996 merged commit c386ef8 into facioquo:main Jan 21, 2024
@LeeDongGeon1996 LeeDongGeon1996 deleted the feature/remove-default-StarcBands branch January 21, 2024 06:26
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@DaveSkender DaveSkender DaveSkender approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@LeeDongGeon1996 @DaveSkender