From e01d0711cfe6e64468765d54ccf1ea6158ac57cd Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Wed, 10 Nov 2021 01:48:35 -0500 Subject: [PATCH] chore: update docs (#601) +semver: minor --- docs/_config.yml | 13 ++++++++----- docs/_indicators/Hurst.md | 2 +- docs/_indicators/StochRsi.md | 2 +- docs/contributing.md | 2 +- src/e-k/Hurst/info.xml | 2 +- 5 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 713fabafe..51ef2818e 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -17,14 +17,17 @@ plugins: google_analytics: G-7602GXEZ0R exclude: [ - "*.yml", - "*.pptx", - "vendor", - "node_modules", "*.json", "*.lock", + "*.yml", + "*.pptx", + "examples/Backtest", "examples/ConsoleApp", - "examples/*.sln" + "examples/*.sln", + "GemFile", + "node_modules", + "offline", + "vendor" ] include: [ diff --git a/docs/_indicators/Hurst.md b/docs/_indicators/Hurst.md index e983760cf..c7ff957c0 100644 --- a/docs/_indicators/Hurst.md +++ b/docs/_indicators/Hurst.md @@ -1,5 +1,5 @@ --- -title: Hurst Exponent (Preview) +title: Hurst Exponent permalink: /indicators/Hurst/ layout: default --- diff --git a/docs/_indicators/StochRsi.md b/docs/_indicators/StochRsi.md index 36fe89139..da02ea389 100644 --- a/docs/_indicators/StochRsi.md +++ b/docs/_indicators/StochRsi.md @@ -26,7 +26,7 @@ IEnumerable results = | `signalPeriods` | int | Number of periods (`G`) in the signal line (SMA of the StochRSI). Must be greater than 0. Typically 3-5. | `smoothPeriods` | int | Smoothing periods (`M`) for the Stochastic. Must be greater than 0. Default is 1 (Fast variant). -The original Stochasic RSI formula uses a the Fast variant of the Stochastic calculation (`smoothPeriods=1`). For a standard period of 14, the original formula would be `GetStochRSI(quotes,14,14,3,1)`; though, the "3" here is just for the Signal, which is not present in the original formula, but useful for additional smoothing of the Stochastic RSI. +The original Stochasic RSI formula uses a the Fast variant of the Stochastic calculation (`smoothPeriods=1`). For a standard period of 14, the original formula would be `quotes.GetStochRSI(14,14,3,1)`. The "3" here is just for the Signal (%D), which is not present in the original formula, but useful for additional smoothing and analysis. ### Historical quotes requirements diff --git a/docs/contributing.md b/docs/contributing.md index 10f7e0186..a27225174 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -110,7 +110,7 @@ This only needs to be done on the merge to `main` when the Pull Request is commi - Adding `+semver: minor` as a PR merge commit message will increment the minor -.x.- element - Adding `+semver: patch` as a PR merge commit message will increment the minor -.-.x element. Patch element auto-increments, so you'd only need to do this to override the next value. -A manual Git `tag`, in accordance with the above schema, is introduced when deploying to the public NuGet package manager and is reflected in the [Releases](https://github.com/DaveSkender/Stock.Indicators/releases). +A Git `tag`, in accordance with the above schema, is introduced automatically after deploying to the public NuGet package manager and is reflected in the [Releases](https://github.com/DaveSkender/Stock.Indicators/releases). ## License diff --git a/src/e-k/Hurst/info.xml b/src/e-k/Hurst/info.xml index dc4e9e119..fe1b939c6 100644 --- a/src/e-k/Hurst/info.xml +++ b/src/e-k/Hurst/info.xml @@ -2,7 +2,7 @@ - (preview) Hurst Exponent is a measure of randomness, trending, and mean-reverting tendencies of incremental return values. + Hurst Exponent is a measure of randomness, trending, and mean-reverting tendencies of incremental return values. See documentation