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

refactor: Naming standardization #1273

Merged
merged 30 commits into from
Dec 1, 2024
Merged

refactor: Naming standardization #1273

merged 30 commits into from
Dec 1, 2024

Conversation

DaveSkender
Copy link
Owner

@DaveSkender DaveSkender commented Nov 11, 2024

done when

  • Rename GetIndex utility methods
  • Add [Obsolete] aliases for GetEma() to ToEma()
  • Add [Obsolete] aliases for Tuple variants
  • Restore SMA variants (with obsolete properties)
  • Other naming updates
  • Update migration guide

@DaveSkender DaveSkender self-assigned this Nov 11, 2024
@DaveSkender DaveSkender changed the base branch from main to v3 November 11, 2024 23:34
Signed-off-by: Dave Skender <[email protected]>
@DaveSkender DaveSkender added this to the v3 milestone Nov 12, 2024
@DaveSkender DaveSkender requested a review from Copilot November 15, 2024 21:22

Choose a reason for hiding this comment

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

Copilot reviewed 6 out of 13 changed files in this pull request and generated no suggestions.

Files not reviewed (7)
  • src/_common/Observables/StreamHub.cs: Evaluated as low risk
  • src/a-d/Alligator/Alligator.StreamHub.cs: Evaluated as low risk
  • src/m-r/Renko/Renko.StreamHub.cs: Evaluated as low risk
  • tests/indicators/_common/Observables/StreamHub.Utilities.Tests.cs: Evaluated as low risk
  • src/a-d/Adl/Adl.StreamHub.cs: Evaluated as low risk
  • src/a-d/AtrStop/AtrStop.StreamHub.cs: Evaluated as low risk
  • src/s-z/Sma/Sma.StreamHub.cs: Evaluated as low risk
Comments skipped due to low confidence (2)

src/a-d/Atr/Atr.StreamHub.cs:75

  • [nitpick] The variable name 'i' is ambiguous. It should be renamed to 'index'.
int i = indexHint ?? ProviderCache.IndexOf(item, true);

src/s-z/Tr/Tr.StreamHub.cs:54

  • [nitpick] The variable name 'i' is ambiguous. It should be renamed to 'index'.
int i = indexHint ?? ProviderCache.IndexOf(item, true);
@DaveSkender DaveSkender requested a review from Copilot November 18, 2024 05:43

Choose a reason for hiding this comment

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

Copilot reviewed 9 out of 23 changed files in this pull request and generated no suggestions.

Files not reviewed (14)
  • src/Indicators.csproj: Language not supported
  • src/_common/Observables/StreamHub.cs: Evaluated as low risk
  • src/a-d/Alligator/Alligator.StreamHub.cs: Evaluated as low risk
  • tests/indicators/m-r/ParabolicSar/ParabolicSar.StaticSeries.Tests.cs: Evaluated as low risk
  • src/m-r/ParabolicSar/ParabolicSar.StaticSeries.cs: Evaluated as low risk
  • src/m-r/Renko/Renko.StreamHub.cs: Evaluated as low risk
  • tests/indicators/_common/Observables/StreamHub.Utilities.Tests.cs: Evaluated as low risk
  • src/_common/ObsoleteV3.cs: Evaluated as low risk
  • src/s-z/StdDevChannels/StdDevChannels.StaticSeries.cs: Evaluated as low risk
  • src/s-z/Sma/Sma.StreamHub.cs: Evaluated as low risk
  • src/a-d/Adl/Adl.StreamHub.cs: Evaluated as low risk
  • src/e-k/Ema/Ema.StreamHub.cs: Evaluated as low risk
  • src/a-d/AtrStop/AtrStop.StreamHub.cs: Evaluated as low risk
  • tests/indicators/e-k/Kvo/Kvo.StaticSeries.Tests.cs: Evaluated as low risk
@DaveSkender DaveSkender requested a review from Copilot November 29, 2024 01:33

Choose a reason for hiding this comment

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

Copilot reviewed 32 out of 46 changed files in this pull request and generated no suggestions.

Files not reviewed (14)
  • .editorconfig: Language not supported
  • src/Directory.Packages.props: Language not supported
  • src/Indicators.csproj: Language not supported
  • src/a-d/Alligator/Alligator.StreamHub.cs: Evaluated as low risk
  • src/a-d/Adl/Adl.StreamHub.cs: Evaluated as low risk
  • src/_common/ObsoleteV3.cs: Evaluated as low risk
  • src/e-k/Ema/Ema.StreamHub.cs: Evaluated as low risk
  • src/_common/Observables/StreamHub.Utilities.cs: Evaluated as low risk
  • src/a-d/Atr/Atr.StreamHub.cs: Evaluated as low risk
  • src/_common/Quotes/Quote.Models.cs: Evaluated as low risk
  • src/_common/Observables/StreamHub.cs: Evaluated as low risk
  • src/a-d/Adx/Adx.BufferList.cs: Evaluated as low risk
  • src/m-r/ParabolicSar/ParabolicSar.StaticSeries.cs: Evaluated as low risk
  • src/m-r/Renko/Renko.StreamHub.cs: Evaluated as low risk
Comments skipped due to low confidence (1)

src/_common/Quotes/Quote.StreamHub.cs:50

  • [nitpick] The method name 'IndexGte' might be unclear. Consider renaming it to 'GetIndexGte' for better clarity.
?? Cache.IndexGte(item.Timestamp);
@DaveSkender DaveSkender requested a review from Copilot November 30, 2024 07:23

Choose a reason for hiding this comment

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

Copilot reviewed 33 out of 47 changed files in this pull request and generated no suggestions.

Files not reviewed (14)
  • .editorconfig: Language not supported
  • src/Directory.Packages.props: Language not supported
  • src/Indicators.csproj: Language not supported
  • src/a-d/Adx/Adx.BufferList.cs: Evaluated as low risk
  • src/_common/Observables/StreamHub.cs: Evaluated as low risk
  • src/s-z/Sma/Sma.StreamHub.cs: Evaluated as low risk
  • src/m-r/RenkoAtr/RenkoAtr.StaticSeries.cs: Evaluated as low risk
  • src/m-r/Renko/Renko.StreamHub.cs: Evaluated as low risk
  • src/_common/Quotes/Quote.StreamHub.cs: Evaluated as low risk
  • src/a-d/Alligator/Alligator.StreamHub.cs: Evaluated as low risk
  • src/m-r/ParabolicSar/ParabolicSar.StaticSeries.cs: Evaluated as low risk
  • src/_common/ObsoleteV3.cs: Evaluated as low risk
  • src/a-d/Adl/Adl.StreamHub.cs: Evaluated as low risk
  • src/e-k/Ema/Ema.StreamHub.cs: Evaluated as low risk
Comments skipped due to low confidence (1)

src/a-d/Atr/Atr.StreamHub.cs:75

  • [nitpick] The method IndexOf is correctly renamed from GetIndex. However, the method's name should be consistent with the other methods in the same file, which use the IndexGte naming convention.
int i = indexHint ?? ProviderCache.IndexOf(item, true);
@DaveSkender DaveSkender requested a review from Copilot December 1, 2024 07:16
@DaveSkender DaveSkender marked this pull request as ready for review December 1, 2024 07:16

Choose a reason for hiding this comment

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

Copilot reviewed 36 out of 50 changed files in this pull request and generated no suggestions.

Files not reviewed (14)
  • .editorconfig: Language not supported
  • src/Directory.Packages.props: Language not supported
  • src/Indicators.csproj: Language not supported
  • src/_common/Reusable/Reusable.Utilities.cs: Evaluated as low risk
  • src/_common/ObsoleteV3.cs: Evaluated as low risk
  • src/a-d/Adl/Adl.StreamHub.cs: Evaluated as low risk
  • src/_common/Quotes/Quote.Models.cs: Evaluated as low risk
  • src/_common/Quotes/Quote.StreamHub.cs: Evaluated as low risk
  • src/_common/Observables/StreamHub.cs: Evaluated as low risk
  • src/a-d/Adx/Adx.BufferList.cs: Evaluated as low risk
  • src/m-r/ParabolicSar/ParabolicSar.StaticSeries.cs: Evaluated as low risk
  • src/a-d/Alligator/Alligator.StreamHub.cs: Evaluated as low risk
  • src/m-r/Renko/Renko.StreamHub.cs: Evaluated as low risk
  • src/e-k/Ema/Ema.StreamHub.cs: Evaluated as low risk
Comments skipped due to low confidence (1)

src/_common/ObsoleteV3.md:18

  • The word 'innaccurately' is misspelled. It should be 'inaccurately'.
The former "Get" prefix innaccurately implied a retrieval operation.
* Add a summary of all technical changes to the public API.
* Enumerate the exact syntax changes.
* Provide a detailed and clear migration path.
* Include specific examples of deprecated and breaking changes.
@DaveSkender DaveSkender enabled auto-merge (squash) December 1, 2024 07:48
@DaveSkender DaveSkender merged commit 204e959 into v3 Dec 1, 2024
11 checks passed
@DaveSkender DaveSkender deleted the v3-refactor-naming branch December 1, 2024 07:49
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 5, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant