Skip to content

Commit 4b35ba3

Browse files
authored
chore: update docs (#889)
+semver: minor
1 parent 0355d3f commit 4b35ba3

8 files changed

Lines changed: 11 additions & 15 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[![Nuget](https://img.shields.io/nuget/dt/skender.stock.indicators?logo=NuGet&label=Downloads)](https://www.nuget.org/packages/Skender.Stock.Indicators)
33
[![code coverage](https://img.shields.io/azure-devops/coverage/skender/stock.indicators/21/main?logo=AzureDevOps&label=Code%20Coverage)](https://dev.azure.com/skender/Stock.Indicators/_build/latest?definitionId=21&branchName=main&view=codecoverage-tab)
44

5-
![image](https://raw.githubusercontent.com/DaveSkender/Stock.Indicators/main/docs/assets/social-banner.png)
5+
[![image](https://raw.githubusercontent.com/DaveSkender/Stock.Indicators/main/docs/assets/social-banner.png)](https://daveskender.github.io/Stock.Indicators/)
66

77
# Stock Indicators for .NET
88

docs/GemFile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ GEM
242242
public_suffix (4.0.7)
243243
racc (1.6.0)
244244
rainbow (3.1.1)
245-
rb-fsevent (0.11.1)
245+
rb-fsevent (0.11.2)
246246
rb-inotify (0.10.1)
247247
ffi (~> 1.0)
248248
rexml (3.2.5)

docs/_indicators/StdDev.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Standard Deviation (volatility)
3-
description: Standard Deviation represents the volatility of historical financial market prices. It is also known as Historical Volatility (HV).
3+
description: Standard Deviation represents the volatility of historical financial market prices. It is also known as Historical Volatility (HV). Z-Score is also returned.
44
permalink: /indicators/StdDev/
55
image: /assets/charts/StdDev.png
66
type: numerical-analysis
@@ -9,7 +9,7 @@ layout: indicator
99

1010
# {{ page.title }}
1111

12-
[Standard Deviation](https://en.wikipedia.org/wiki/Standard_deviation) of price over a rolling lookback window. Also known as Historical Volatility (HV).
12+
[Standard Deviation](https://en.wikipedia.org/wiki/Standard_deviation) of price over a rolling lookback window. Also known as Historical Volatility (HV). Z-Score is also returned.
1313
[[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/239 "Community discussion about this indicator")
1414

1515
![image]({{site.baseurl}}{{page.image}})

docs/_indicators/Stoch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Stochastic Oscillator
3-
description: Created by George Lane, the Stochastic Oscillator is a momentum oscillator that compares current financial market price with recent highs and lows and is presented on a scale of 0 to 100. %J is also included for the KDJ Index extension.
3+
description: Created by George Lane, the Stochastic Oscillator, also known as KDJ Index, is a momentum oscillator that compares current financial market price with recent highs and lows and is presented on a scale of 0 to 100. %J is also included for the KDJ Index extension.
44
permalink: /indicators/Stoch/
55
image: /assets/charts/Stoch.png
66
type: oscillator
@@ -11,7 +11,7 @@ redirect_from:
1111

1212
# {{ page.title }}
1313

14-
Created by George Lane, the [Stochastic Oscillator](https://en.wikipedia.org/wiki/Stochastic_oscillator) is a momentum oscillator that compares current price with recent highs and lows and is presented on a scale of 0 to 100. %J is also included for the KDJ Index extension.
14+
Created by George Lane, the [Stochastic Oscillator](https://en.wikipedia.org/wiki/Stochastic_oscillator), also known as KDJ Index, is a momentum oscillator that compares current price with recent highs and lows and is presented on a scale of 0 to 100.
1515
[[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/237 "Community discussion about this indicator")
1616

1717
![image]({{site.baseurl}}{{page.image}})

src/a-d/AtrStop/info.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@
1616
<param name="lookbackPeriods">Number of periods for ATR.</param>
1717
<param name="multiplier">Multiplier sets the ATR band width.</param>
1818
<param name="endType">Sets basis for stop offsets (Close or High/Low).</param>
19-
<returns>Time series of AtrStop values.</returns>
19+
<returns>Time series of ATR Trailing Stop values.</returns>
2020
<exception cref="ArgumentOutOfRangeException">Invalid parameter value provided.</exception>
21-
</info>
21+
</info>

src/m-r/Renko/Renko.Series.cs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ private static int GetNewBricks<TQuote>(
110110
decimal brickSize)
111111
where TQuote : IQuote
112112
{
113-
int bricks;
113+
int bricks = 0;
114114
decimal upper = Math.Max(lastBrick.Open, lastBrick.Close);
115115
decimal lower = Math.Min(lastBrick.Open, lastBrick.Close);
116116

@@ -136,10 +136,6 @@ private static int GetNewBricks<TQuote>(
136136

137137
bricks = (int)((hQty >= lQty) ? hQty : -lQty);
138138
break;
139-
140-
default:
141-
bricks = 0;
142-
break;
143139
}
144140

145141
return bricks;

tests/external/Tests.Other.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</PropertyGroup>
1515

1616
<ItemGroup>
17-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.0" />
17+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.1" />
1818
<PackageReference Include="MSTest.TestAdapter" Version="2.2.10" />
1919
<PackageReference Include="MSTest.TestFramework" Version="2.2.10" />
2020
<PackageReference Include="StyleCop.Analyzers" Version="1.1.118">

tests/indicators/Tests.Indicators.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</PropertyGroup>
1515

1616
<ItemGroup>
17-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.0" />
17+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.1" />
1818
<PackageReference Include="MSTest.TestAdapter" Version="2.2.10" />
1919
<PackageReference Include="MSTest.TestFramework" Version="2.2.10" />
2020
<PackageReference Include="coverlet.collector" Version="3.1.2">

0 commit comments

Comments
 (0)