Skip to content

Commit 335a5a8

Browse files
committed
Update function comments to be more contextually correct
1 parent df3b039 commit 335a5a8

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

glean/src/core/metrics/distributions.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,6 @@ export interface DistributionData {
2323
*
2424
* Utility function for testing.
2525
*
26-
* **Caution**
27-
* This cannot use `Histogram.snapshot_values` and needs to use the more
28-
* specialized snapshot function.
29-
*
3026
* @param hist Histogram to get the snapshot of.
3127
* @returns Snapshot of the current histogram.
3228
*/
@@ -50,11 +46,11 @@ export function snapshot(hist: Histogram): DistributionData {
5046

5147
/**
5248
* Takes the previous values and casts as a `number[]` or creates a new empty `number[]`. We store
53-
* previous durations as an array of values so that we can always reconstruct our histogram. We
49+
* previous values as an array so that we can always reconstruct our histogram. We
5450
* are unable to store complex objects in Glean as they must be JSON parse-able objects.
5551
*
5652
* @param jsonValue Will always be either undefined or a `number[]`.
57-
* @returns An array of previous durations or an empty array if nothing was previously stored.
53+
* @returns An array of previous values or an empty array if nothing was previously stored.
5854
*/
5955
export function extractAccumulatedValuesFromJsonValue(jsonValue?: JSONValue): number[] {
6056
let values: number[];

0 commit comments

Comments
 (0)