diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 94f163e9b..05ceb88fa 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -58,4 +58,4 @@ jobs: accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} projectName: ${{ vars.CLOUDFLARE_PROJECT_NAME }} directory: docs/_site - wranglerVersion: '3' \ No newline at end of file + wranglerVersion: 'latest' \ No newline at end of file diff --git a/.github/workflows/docs-test-links.yml b/.github/workflows/docs-test-links.yml index 474ed211b..4ddd605a7 100644 --- a/.github/workflows/docs-test-links.yml +++ b/.github/workflows/docs-test-links.yml @@ -68,6 +68,6 @@ jobs: run: | htmlproofer _site \ --no-enforce-https \ - --ignore-status-codes "403,406,408,429,503,999" \ + --ignore-status-codes "0,403,406,408,429,503,999" \ --swap-urls "https\://dotnet.stockindicators.dev:http\://127.0.0.1:4000" \ --ignore-urls "/fonts.gstatic.com/" diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml new file mode 100644 index 000000000..c98c1bca8 --- /dev/null +++ b/.github/workflows/semantic-pr-linter.yml @@ -0,0 +1,70 @@ +name: "Lint PR" + +on: + pull_request_target: + types: + - opened + - edited + - synchronize + +permissions: + pull-requests: write + +jobs: + main: + name: Validate PR title + runs-on: ubuntu-latest + steps: + - uses: amannn/action-semantic-pull-request@v5 + id: lint_pr_title + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + + # Configure additional validation for the subject based on a regex. + # We enforce that the subject starts with an uppercase character. + subjectPattern: ^([A-Z]).+$ + + # If `subjectPattern` is configured, you can use this property to override + # the default error message that is shown when the pattern doesn't match. + # The variables `subject` and `title` can be used within the message. + subjectPatternError: > + The subject "**{subject}**" found in the pull request title "*{title}*" + didn't match the configured pattern. Please ensure that the subject + starts with an uppercase character. + + # If the PR contains one of these newline-delimited labels, the + # validation is skipped. If you want to rerun the validation when + # labels change, you might want to use the `labeled` and `unlabeled` + # event triggers in your workflow. + ignoreLabels: | + bot + ignore-semantic-pull-request + + - uses: marocchino/sticky-pull-request-comment@v2 + # When the previous steps fails, the workflow would stop. By adding this + # condition you can continue the execution with the populated error message. + if: always() && (steps.lint_pr_title.outputs.error_message != null) + with: + header: pr-title-lint-error + message: > + ### Hey there and thank you for opening this pull request! πŸ‘‹πŸΌ + + It looks like your proposed **_Pull request title_** needs to be adjusted. + + >🚩 **ERROR:** ${{ steps.lint_pr_title.outputs.error_message }} + + #### Pull request title naming convention + + Our PR title name taxonomy is `type: Subject`, where **type** is typically + *feat*, *fix*, or *chore* and **subject** is a noun that starts with a capitalized letter. + The *chore* type usually has a subject that starts with an action verb like *Add* or *Update*. + Examples: `feat: Admin portal login`, `fix: Divide by zero bug in SMA`, and `chore: Update user docs`. + See the [Conventional Commits specification](https://www.conventionalcommits.org) for more information. + + # Delete a previous comment when the issue has been resolved + - if: ${{ steps.lint_pr_title.outputs.error_message == null }} + uses: marocchino/sticky-pull-request-comment@v2 + with: + header: pr-title-lint-error + delete: true diff --git a/docs/_indicators/Adl.md b/docs/_indicators/Adl.md index 936d97037..48acef9f0 100644 --- a/docs/_indicators/Adl.md +++ b/docs/_indicators/Adl.md @@ -15,7 +15,7 @@ Created by Marc Chaikin, the [Accumulation/Distribution Line/Index](https://en.w ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetAdl(); diff --git a/docs/_indicators/Adx.md b/docs/_indicators/Adx.md index e840821d6..7dafdc672 100644 --- a/docs/_indicators/Adx.md +++ b/docs/_indicators/Adx.md @@ -15,7 +15,7 @@ Created by J. Welles Wilder, the Directional Movement Index (DMI) and [Average D ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetAdx(lookbackPeriods); ``` diff --git a/docs/_indicators/Alligator.md b/docs/_indicators/Alligator.md index 028a16ae0..1b291c37a 100644 --- a/docs/_indicators/Alligator.md +++ b/docs/_indicators/Alligator.md @@ -15,7 +15,7 @@ Created by Bill Williams, Alligator is a depiction of three smoothed moving aver ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetAlligator(jawPeriods,jawOffset,teethPeriods,teethOffset,lipsPeriods,lipsOffset); ``` diff --git a/docs/_indicators/Alma.md b/docs/_indicators/Alma.md index 07a599748..d378287cf 100644 --- a/docs/_indicators/Alma.md +++ b/docs/_indicators/Alma.md @@ -15,7 +15,7 @@ Created by Arnaud Legoux and Dimitrios Kouzis-Loukas, [ALMA]({{site.github.repos ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetAlma(lookbackPeriods, offset, sigma); ``` diff --git a/docs/_indicators/Aroon.md b/docs/_indicators/Aroon.md index ce698a66b..14d8b3fb7 100644 --- a/docs/_indicators/Aroon.md +++ b/docs/_indicators/Aroon.md @@ -15,7 +15,7 @@ Created by Tushar Chande, [Aroon](https://school.stockcharts.com/doku.php?id=tec ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetAroon(lookbackPeriods); ``` diff --git a/docs/_indicators/Atr.md b/docs/_indicators/Atr.md index 4bc0f3d27..d317e188d 100644 --- a/docs/_indicators/Atr.md +++ b/docs/_indicators/Atr.md @@ -15,7 +15,7 @@ Created by J. Welles Wilder, True Range and [Average True Range](https://en.wiki ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// standard usage +// C# usage syntax IEnumerable results = quotes.GetAtr(lookbackPeriods); diff --git a/docs/_indicators/AtrStop.md b/docs/_indicators/AtrStop.md index 305dd6a38..31430f322 100644 --- a/docs/_indicators/AtrStop.md +++ b/docs/_indicators/AtrStop.md @@ -15,7 +15,7 @@ Created by Welles Wilder, the ATR Trailing Stop indicator attempts to determine ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetAtrStop(lookbackPeriods, multiplier, endType); ``` diff --git a/docs/_indicators/Awesome.md b/docs/_indicators/Awesome.md index 980663283..cbade963f 100644 --- a/docs/_indicators/Awesome.md +++ b/docs/_indicators/Awesome.md @@ -15,7 +15,7 @@ Created by Bill Williams, the Awesome Oscillator (aka Super AO) is a measure of ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetAwesome(fastPeriods, slowPeriods); ``` diff --git a/docs/_indicators/BasicQuote.md b/docs/_indicators/BasicQuote.md index a63cf9f3d..765060e69 100644 --- a/docs/_indicators/BasicQuote.md +++ b/docs/_indicators/BasicQuote.md @@ -11,7 +11,7 @@ layout: indicator Returns a basic quote transform (e.g. HL2, OHL3, etc.) and isolation of individual price quote candle parts from a full OHLCV quote. ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetBaseQuote(candlePart); ``` diff --git a/docs/_indicators/Beta.md b/docs/_indicators/Beta.md index 46e01b116..bf47c3e59 100644 --- a/docs/_indicators/Beta.md +++ b/docs/_indicators/Beta.md @@ -15,7 +15,7 @@ layout: indicator ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotesEval .GetBeta(quotesMarket, lookbackPeriods, type); ``` diff --git a/docs/_indicators/BollingerBands.md b/docs/_indicators/BollingerBands.md index 302ec4c04..94837ad65 100644 --- a/docs/_indicators/BollingerBands.md +++ b/docs/_indicators/BollingerBands.md @@ -15,7 +15,7 @@ Created by John Bollinger, [Bollinger Bands](https://en.wikipedia.org/wiki/Bolli ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetBollingerBands(lookbackPeriods, standardDeviations); ``` diff --git a/docs/_indicators/Bop.md b/docs/_indicators/Bop.md index 01700bea0..6fa6f02c9 100644 --- a/docs/_indicators/Bop.md +++ b/docs/_indicators/Bop.md @@ -15,7 +15,7 @@ Created by Igor Levshin, the [Balance of Power](https://school.stockcharts.com/d ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetBop(smoothPeriods); ``` diff --git a/docs/_indicators/Cci.md b/docs/_indicators/Cci.md index 218387951..9b9c27cb6 100644 --- a/docs/_indicators/Cci.md +++ b/docs/_indicators/Cci.md @@ -15,7 +15,7 @@ Created by Donald Lambert, the [Commodity Channel Index](https://en.wikipedia.or ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetCci(lookbackPeriods); ``` diff --git a/docs/_indicators/ChaikinOsc.md b/docs/_indicators/ChaikinOsc.md index f2bc7bce3..f73f20a50 100644 --- a/docs/_indicators/ChaikinOsc.md +++ b/docs/_indicators/ChaikinOsc.md @@ -15,7 +15,7 @@ Created by Marc Chaikin, the [Chaikin Oscillator](https://en.wikipedia.org/wiki/ ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetChaikinOsc(fastPeriods, slowPeriods); ``` diff --git a/docs/_indicators/Chandelier.md b/docs/_indicators/Chandelier.md index b038a3b7d..bbcaec658 100644 --- a/docs/_indicators/Chandelier.md +++ b/docs/_indicators/Chandelier.md @@ -16,7 +16,7 @@ Created by Charles Le Beau, the [Chandelier Exit](https://school.stockcharts.com ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetChandelier(lookbackPeriods, multiplier, type); ``` diff --git a/docs/_indicators/Chop.md b/docs/_indicators/Chop.md index 44d8ed0dc..491f1bfb0 100644 --- a/docs/_indicators/Chop.md +++ b/docs/_indicators/Chop.md @@ -14,7 +14,7 @@ Created by E.W. Dreiss, the Choppiness Index measures the trendiness or choppine ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetChop(lookbackPeriods); ``` diff --git a/docs/_indicators/Cmf.md b/docs/_indicators/Cmf.md index aec1f723b..8a254c0b4 100644 --- a/docs/_indicators/Cmf.md +++ b/docs/_indicators/Cmf.md @@ -15,7 +15,7 @@ Created by Marc Chaikin, [Chaikin Money Flow](https://en.wikipedia.org/wiki/Chai ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetCmf(lookbackPeriods); ``` diff --git a/docs/_indicators/Cmo.md b/docs/_indicators/Cmo.md index 4d374ac28..a57e08b48 100644 --- a/docs/_indicators/Cmo.md +++ b/docs/_indicators/Cmo.md @@ -15,7 +15,7 @@ Created by Tushar Chande, the [Chande Momentum Oscillator](https://www.investope ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetCmo(lookbackPeriods); ``` diff --git a/docs/_indicators/ConnorsRsi.md b/docs/_indicators/ConnorsRsi.md index de4495c88..e5553fb10 100644 --- a/docs/_indicators/ConnorsRsi.md +++ b/docs/_indicators/ConnorsRsi.md @@ -15,7 +15,7 @@ Created by Laurence Connors, the [ConnorsRSI](https://alvarezquanttrading.com/wp ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetConnorsRsi(rsiPeriods, streakPeriods, rankPeriods); ``` diff --git a/docs/_indicators/Correlation.md b/docs/_indicators/Correlation.md index 66d4cb550..7f0a307a3 100644 --- a/docs/_indicators/Correlation.md +++ b/docs/_indicators/Correlation.md @@ -15,7 +15,7 @@ Created by Karl Pearson, the [Correlation Coefficient](https://en.wikipedia.org/ ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotesA.GetCorrelation(quotesB, lookbackPeriods); ``` diff --git a/docs/_indicators/Dema.md b/docs/_indicators/Dema.md index 1a2c1f011..f3a9cbaf2 100644 --- a/docs/_indicators/Dema.md +++ b/docs/_indicators/Dema.md @@ -17,7 +17,7 @@ Created by Patrick G. Mulloy, the [Double exponential moving average](https://en ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetDema(lookbackPeriods); ``` diff --git a/docs/_indicators/Doji.md b/docs/_indicators/Doji.md index 0e2ac77b1..42c32d134 100644 --- a/docs/_indicators/Doji.md +++ b/docs/_indicators/Doji.md @@ -15,7 +15,7 @@ type: candlestick-pattern ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetDoji(maxPriceChangePercent); ``` diff --git a/docs/_indicators/Donchian.md b/docs/_indicators/Donchian.md index 36d7a969c..8f1c1d9a8 100644 --- a/docs/_indicators/Donchian.md +++ b/docs/_indicators/Donchian.md @@ -16,7 +16,7 @@ Created by Richard Donchian, [Donchian Channels](https://en.wikipedia.org/wiki/D ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetDonchian(lookbackPeriods); ``` diff --git a/docs/_indicators/Dpo.md b/docs/_indicators/Dpo.md index be07ac67a..17a346fdb 100644 --- a/docs/_indicators/Dpo.md +++ b/docs/_indicators/Dpo.md @@ -15,7 +15,7 @@ layout: indicator ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetDpo(lookbackPeriods); ``` diff --git a/docs/_indicators/Dynamic.md b/docs/_indicators/Dynamic.md index 723520054..bebcfc7f6 100644 --- a/docs/_indicators/Dynamic.md +++ b/docs/_indicators/Dynamic.md @@ -15,7 +15,7 @@ Created by John R. McGinley, the [McGinley Dynamic](https://www.investopedia.com ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage (with Close price) +// C# usage syntax (with Close price) IEnumerable results = quotes.GetDynamic(lookbackPeriods, kFactor); ``` diff --git a/docs/_indicators/ElderRay.md b/docs/_indicators/ElderRay.md index 499c0866a..7f23110de 100644 --- a/docs/_indicators/ElderRay.md +++ b/docs/_indicators/ElderRay.md @@ -15,7 +15,7 @@ Created by Alexander Elder, the [Elder-ray Index](https://www.investopedia.com/t ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetElderRay(lookbackPeriods); ``` diff --git a/docs/_indicators/Ema.md b/docs/_indicators/Ema.md index b9a7530b5..f77adfe7d 100644 --- a/docs/_indicators/Ema.md +++ b/docs/_indicators/Ema.md @@ -15,7 +15,7 @@ layout: indicator ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage (with Close price) +// C# usage syntax (with Close price) IEnumerable results = quotes.GetEma(lookbackPeriods); ``` diff --git a/docs/_indicators/Epma.md b/docs/_indicators/Epma.md index 8ec15e960..f37865059 100644 --- a/docs/_indicators/Epma.md +++ b/docs/_indicators/Epma.md @@ -15,7 +15,7 @@ Endpoint Moving Average (EPMA), also known as Least Squares Moving Average (LSMA ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetEpma(lookbackPeriods); ``` diff --git a/docs/_indicators/Fcb.md b/docs/_indicators/Fcb.md index b8ec19ba6..f0ccdc7f6 100644 --- a/docs/_indicators/Fcb.md +++ b/docs/_indicators/Fcb.md @@ -15,7 +15,7 @@ Created by Edward William Dreiss, Fractal Chaos Bands outline high and low price ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetFcb(windowSpan); ``` diff --git a/docs/_indicators/FisherTransform.md b/docs/_indicators/FisherTransform.md index 6075ea26d..746e7b37a 100644 --- a/docs/_indicators/FisherTransform.md +++ b/docs/_indicators/FisherTransform.md @@ -15,7 +15,7 @@ Created by John Ehlers, the [Fisher Transform](https://www.investopedia.com/term ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetFisherTransform(lookbackPeriods); ``` diff --git a/docs/_indicators/ForceIndex.md b/docs/_indicators/ForceIndex.md index b0607660c..60e992b5b 100644 --- a/docs/_indicators/ForceIndex.md +++ b/docs/_indicators/ForceIndex.md @@ -15,7 +15,7 @@ Created by Alexander Elder, the [Force Index](https://en.wikipedia.org/wiki/Forc ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetForceIndex(lookbackPeriods); ``` diff --git a/docs/_indicators/Fractal.md b/docs/_indicators/Fractal.md index 1d1c0af6e..78087ebf0 100644 --- a/docs/_indicators/Fractal.md +++ b/docs/_indicators/Fractal.md @@ -15,7 +15,7 @@ Created by Larry Williams, [Fractal](https://www.investopedia.com/terms/f/fracta ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetFractal(windowSpan); ``` diff --git a/docs/_indicators/Gator.md b/docs/_indicators/Gator.md index ebc738d8a..c0db697da 100644 --- a/docs/_indicators/Gator.md +++ b/docs/_indicators/Gator.md @@ -15,7 +15,7 @@ Created by Bill Williams, the Gator Oscillator is an expanded oscillator view of ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetGator(); diff --git a/docs/_indicators/HeikinAshi.md b/docs/_indicators/HeikinAshi.md index f059abf95..608f7af53 100644 --- a/docs/_indicators/HeikinAshi.md +++ b/docs/_indicators/HeikinAshi.md @@ -15,7 +15,7 @@ Created by Munehisa Homma, [Heikin-Ashi](https://en.wikipedia.org/wiki/Candlesti ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetHeikinAshi(); ``` diff --git a/docs/_indicators/Hma.md b/docs/_indicators/Hma.md index 44aebaf8c..bde67341b 100644 --- a/docs/_indicators/Hma.md +++ b/docs/_indicators/Hma.md @@ -15,7 +15,7 @@ Created by Alan Hull, the [Hull Moving Average](https://alanhull.com/hull-moving ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetHma(lookbackPeriods); ``` diff --git a/docs/_indicators/HtTrendline.md b/docs/_indicators/HtTrendline.md index 0c9fbdd54..3e3252ca2 100644 --- a/docs/_indicators/HtTrendline.md +++ b/docs/_indicators/HtTrendline.md @@ -15,7 +15,7 @@ Created by John Ehlers, the Hilbert Transform Instantaneous Trendline is a 5-per ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetHtTrendline(); ``` diff --git a/docs/_indicators/Hurst.md b/docs/_indicators/Hurst.md index 848615ec1..0595ecca5 100644 --- a/docs/_indicators/Hurst.md +++ b/docs/_indicators/Hurst.md @@ -15,7 +15,7 @@ The [Hurst Exponent](https://en.wikipedia.org/wiki/Hurst_exponent) (`H`) is part ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetHurst(lookbackPeriods); ``` diff --git a/docs/_indicators/Ichimoku.md b/docs/_indicators/Ichimoku.md index f98460f6d..ea4ce2618 100644 --- a/docs/_indicators/Ichimoku.md +++ b/docs/_indicators/Ichimoku.md @@ -15,7 +15,7 @@ Created by Goichi Hosoda (η΄°η”°ζ‚ŸδΈ€, Hosoda Goichi), [Ichimoku Cloud](https:/ ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetIchimoku(tenkanPeriods, kijunPeriods, senkouBPeriods); diff --git a/docs/_indicators/Kama.md b/docs/_indicators/Kama.md index 51d596901..e2cba8e20 100644 --- a/docs/_indicators/Kama.md +++ b/docs/_indicators/Kama.md @@ -15,7 +15,7 @@ Created by Perry Kaufman, [KAMA](https://school.stockcharts.com/doku.php?id=tech ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetKama(erPeriods, fastPeriods, slowPeriods); ``` diff --git a/docs/_indicators/Keltner.md b/docs/_indicators/Keltner.md index 33592621a..c15e81eac 100644 --- a/docs/_indicators/Keltner.md +++ b/docs/_indicators/Keltner.md @@ -15,7 +15,7 @@ Created by Chester W. Keltner, [Keltner Channels](https://en.wikipedia.org/wiki/ ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetKeltner(emaPeriods, multiplier, atrPeriods); ``` diff --git a/docs/_indicators/Kvo.md b/docs/_indicators/Kvo.md index b73aa9f72..f676f822c 100644 --- a/docs/_indicators/Kvo.md +++ b/docs/_indicators/Kvo.md @@ -15,7 +15,7 @@ Created by Stephen Klinger, the [Klinger Volume Oscillator](https://www.investop ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetKvo(shortPeriods, longPeriods, signalPeriods); ``` diff --git a/docs/_indicators/MaEnvelopes.md b/docs/_indicators/MaEnvelopes.md index f1bef9141..88ba0c220 100644 --- a/docs/_indicators/MaEnvelopes.md +++ b/docs/_indicators/MaEnvelopes.md @@ -15,7 +15,7 @@ layout: indicator ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetMaEnvelopes(lookbackPeriods, percentOffset, movingAverageType); ``` diff --git a/docs/_indicators/Macd.md b/docs/_indicators/Macd.md index 4224f2c86..2ca2938b0 100644 --- a/docs/_indicators/Macd.md +++ b/docs/_indicators/Macd.md @@ -15,7 +15,7 @@ Created by Gerald Appel, [MACD](https://en.wikipedia.org/wiki/MACD) is a simple ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage (with Close price) +// C# usage syntax (with Close price) IEnumerable results = quotes.GetMacd(fastPeriods, slowPeriods, signalPeriods); ``` diff --git a/docs/_indicators/Mama.md b/docs/_indicators/Mama.md index a7dd12323..29c244ea6 100644 --- a/docs/_indicators/Mama.md +++ b/docs/_indicators/Mama.md @@ -15,7 +15,7 @@ Created by John Ehlers, the [MAMA](https://mesasoftware.com/papers/MAMA.pdf) ind ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetMama(fastLimit, slowLimit); ``` diff --git a/docs/_indicators/Marubozu.md b/docs/_indicators/Marubozu.md index b17b6111e..75abe1d69 100644 --- a/docs/_indicators/Marubozu.md +++ b/docs/_indicators/Marubozu.md @@ -15,7 +15,7 @@ type: candlestick-pattern ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetMarubozu(minBodyPercent); ``` diff --git a/docs/_indicators/Mfi.md b/docs/_indicators/Mfi.md index 54b0a6a4e..16f58a2b0 100644 --- a/docs/_indicators/Mfi.md +++ b/docs/_indicators/Mfi.md @@ -15,7 +15,7 @@ Created by Quong and Soudack, the [Money Flow Index](https://en.wikipedia.org/wi ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetMfi(lookbackPeriods); ``` diff --git a/docs/_indicators/Obv.md b/docs/_indicators/Obv.md index 98eb8bd83..4da972f7d 100644 --- a/docs/_indicators/Obv.md +++ b/docs/_indicators/Obv.md @@ -15,7 +15,7 @@ Popularized by Joseph Granville, [On-balance Volume](https://en.wikipedia.org/wi ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetObv(); diff --git a/docs/_indicators/ParabolicSar.md b/docs/_indicators/ParabolicSar.md index 0050a162d..ee3bebee7 100644 --- a/docs/_indicators/ParabolicSar.md +++ b/docs/_indicators/ParabolicSar.md @@ -15,7 +15,7 @@ Created by J. Welles Wilder, [Parabolic SAR](https://en.wikipedia.org/wiki/Parab ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage (standard) +// C# usage syntax (standard) IEnumerable results = quotes.GetParabolicSar(accelerationStep, maxAccelerationFactor); diff --git a/docs/_indicators/PivotPoints.md b/docs/_indicators/PivotPoints.md index 83526fdf5..727dc0d1e 100644 --- a/docs/_indicators/PivotPoints.md +++ b/docs/_indicators/PivotPoints.md @@ -16,7 +16,7 @@ layout: indicator ![chart for {{page.title}}]({{site.baseurl}}{{page.image}}) ```csharp -// usage +// C# usage syntax IEnumerable results = quotes.GetPivotPoints(windowSize, pointType); ``` diff --git a/docs/_indicators/Pivots.md b/docs/_indicators/Pivots.md index b5738a50d..006f7d3cb 100644 --- a/docs/_indicators/Pivots.md +++ b/docs/_indicators/Pivots.md @@ -15,7 +15,7 @@ Pivots is an extended customizable version of