Skip to content

Commit

Permalink
chore: update docs (#825)
Browse files Browse the repository at this point in the history
* slope docs
* roc with bands doc fixes
* remove PRS warning messages
DaveSkender authored Jun 20, 2022
1 parent 4589861 commit 90532a5
Showing 5 changed files with 2 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/_indicators/RocWb.md
Original file line number Diff line number Diff line change
@@ -36,7 +36,7 @@ You must have at least `N+1` periods of `quotes` to cover the warmup periods.
## Response

```csharp
IEnumerable<RocResult>
IEnumerable<RocWbResult>
```

- This method returns a time series of all available indicator values for the `quotes` provided.
2 changes: 1 addition & 1 deletion docs/_indicators/Slope.md
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ layout: indicator

# {{ page.title }}

[Slope of the best fit line](https://school.stockcharts.com/doku.php?id=technical_indicators:slope) is determined by an [ordinary least-squares simple linear regression](https://en.wikipedia.org/wiki/Simple_linear_regression) on Close price. It can be used to help identify trend strength and direction. Standard Deviation, R&sup2;, and a best-fit `Line` (for last lookback segment) are also output. See also [Standard Deviation Channels]({{site.baseurl}}/indicators/StdDevChannels/#content) for an alternative depiction.
[Slope of the best fit line](https://school.stockcharts.com/doku.php?id=technical_indicators:slope) is determined by an [ordinary least-squares simple linear regression](https://en.wikipedia.org/wiki/Simple_linear_regression) on price. It can be used to help identify trend strength and direction.
[[Discuss] :speech_balloon:]({{site.github.repository_url}}/discussions/241 "Community discussion about this indicator")

![image]({{site.baseurl}}/assets/charts/Linear.png)
1 change: 0 additions & 1 deletion src/m-r/Prs/Prs.Api.cs
Original file line number Diff line number Diff line change
@@ -6,7 +6,6 @@ public static partial class Indicator
// SERIES, from TQuote
/// <include file='./info.xml' path='info/*' />
///
[Obsolete("Eval and Base quotes have been reversed in v2! Ensure you swap parameter location. This warning will be removed after v2.0.0")]
public static IEnumerable<PrsResult> GetPrs<TQuote>(
this IEnumerable<TQuote> quotesEval,
IEnumerable<TQuote> quotesBase,
1 change: 0 additions & 1 deletion tests/indicators/m-r/Prs/Prs.Tests.cs
Original file line number Diff line number Diff line change
@@ -4,7 +4,6 @@
namespace Internal.Tests;

[TestClass]
#pragma warning disable CS0618 // Type or member is obsolete
public class Prs : TestBase
{
[TestMethod]
4 changes: 0 additions & 4 deletions tests/performance/Perf.Indicators.cs
Original file line number Diff line number Diff line change
@@ -212,14 +212,10 @@ public object GetEmaStream()
public object GetPmo() => h.GetPmo();

[Benchmark]
#pragma warning disable CS0618 // Type or member is obsolete
public object GetPrs() => h.GetPrs(ho);
#pragma warning restore CS0618 // Type or member is obsolete

[Benchmark]
#pragma warning disable CS0618 // Type or member is obsolete
public object GetPrsWithSma() => h.GetPrs(ho, null, 5);
#pragma warning restore CS0618 // Type or member is obsolete

[Benchmark]
public object GetPvo() => h.GetPvo();

0 comments on commit 90532a5

Please sign in to comment.