Skip to content

Commit 49d6bc1

Browse files
JulianLeglervprashar2929
authored andcommitted
docs(metrics): fix trailing whitespace in metrics docs generator to pass the pre-commit action
Signed-off-by: JulianLegler <julian.legler@tu-berlin.de>
1 parent 4a4bf34 commit 49d6bc1

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/user/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ CPU energy and power metrics carry a `zone` label. A zone is a hardware power do
2121
- `uncore`: the uncore parts of the package, such as an integrated GPU
2222
- `dram`: the memory attached to the memory controller
2323

24-
Which zones are exported depends entirely on what the hardware and the kernel expose on that machine. It is common that CPUs support only a subset of these zones. A zone that is not available will not appear in the metrics.
24+
Which zones are exported depends entirely on what the hardware and the kernel expose on that machine. It is common that CPUs support only a subset of these zones. A zone that is not available will not appear in the metrics.
2525

2626
Some zones overlap and therefore zones should not be summed. `package` already contains `core`, `uncore`, and part of what `psys` covers. It is advised to filter on a single zone in queries, for example `kepler_node_cpu_watts{zone="package"}`.
2727

hack/gen-metric-docs/main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,10 +212,10 @@ func generateMarkdown(metrics []MetricInfo) string {
212212
md.WriteString("- `uncore`: the uncore parts of the package, such as an integrated GPU\n")
213213
md.WriteString("- `dram`: the memory attached to the memory controller\n\n")
214214
md.WriteString("Which zones are exported depends entirely on what the hardware and the kernel expose on that machine. ")
215-
md.WriteString("It is common that CPUs support only a subset of these zones. A zone that is not available will not appear in the metrics. \n\n")
215+
md.WriteString("It is common that CPUs support only a subset of these zones. A zone that is not available will not appear in the metrics.\n\n")
216216
md.WriteString("Some zones overlap and therefore zones should not be summed. `package` already contains `core`, `uncore`, and part of what `psys` covers. ")
217217
md.WriteString("It is advised to filter on a single zone in queries, for example `kepler_node_cpu_watts{zone=\"package\"}`.\n\n")
218-
218+
219219
md.WriteString("## Metrics Reference\n\n")
220220

221221
nodeMetrics := []MetricInfo{}

0 commit comments

Comments
 (0)