Skip to content

Commit

Permalink
Merge pull request #344 from GridProtectionAlliance/UpdatedGSFGrafanF…
Browse files Browse the repository at this point in the history
…orwardText

GenerateGrafanaFunctionsMarkdown: Updated forward text
  • Loading branch information
ritchiecarroll authored Dec 20, 2024
2 parents 2fcc5b6 + e5eff65 commit 880d7ed
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ namespace GrafanaAdapters.Functions.BuiltIn;
/// of exceeding. <c>returnDurations</c>, optional, is a boolean that determines if the duration (in seconds) from where
/// value exceeded threshold should be returned instead of the original value. Forth parameter, <c>reportEndMarker</c>,
/// is a boolean flag that determines if a value should be reported at the point when threshold stops being exceeding
/// the threshold.
/// the threshold.<br/>
/// See <see href=
/// "https://github.com/GridProtectionAlliance/GrafanaTemplates?tab=readme-ov-file#exceedsat-threshold-dashboard">
/// example template dashboard</see>.
/// </summary>
/// <remarks>
/// Signature: <c>ExceedsAt(threshold, [fallsBelow = false], [returnDurations = false], [reportEndMarker = false], expression)</c><br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The following optional special command operations can be specified as part of an
| Command | Description |
| ------- | ----------- |
| `DropEmptySeries` | Ensures any empty series are hidden from display. Example: `; dropEmptySeries` |
| `FullResolutionQuery` | Ensures query returns non-decimated, full resolution data. Example: `; fullResolutionData` |
| `FullResolutionQuery` | Ensures query returns non-decimated, full resolution data. Example: `; FullResolutionQuery` |
| `IncludePeaks` | Ensures decimated data includes both min/max interval peaks, note this can reduce query performance. Example: `; includePeaks` |
| `RadialDistribution` | Updates query coordinate metadata, i.e., longitude/latitude, where values overlap in a radial distribution. Example: `; radialDistribution` |
| `SquareDistribution` | Updates query coordinate metadata, i.e., longitude/latitude, where values overlap in a square distribution. Example: `; squareDistribution` |
Expand Down

0 comments on commit 880d7ed

Please sign in to comment.