Update VERTICAL_RATIO documentation
Bug: 330899776
Change-Id: I14d3387adebf66e21c395857a1a9e3bd3d2f5d3d
Test: N/A
diff --git a/health/health-services-client/src/main/java/androidx/health/services/client/data/DataType.kt b/health/health-services-client/src/main/java/androidx/health/services/client/data/DataType.kt
index 40bde13..575812e 100644
--- a/health/health-services-client/src/main/java/androidx/health/services/client/data/DataType.kt
+++ b/health/health-services-client/src/main/java/androidx/health/services/client/data/DataType.kt
@@ -651,16 +651,20 @@
createStatsDataType("Vertical Oscillation")
/**
- * Vertical oscillation / stride length. Divide vertical oscillation (converted to meters)
- * by stride length (in meters) in `double` format.
+ * Vertical oscillation / stride length.
+ *
+ * For example, a vertical oscillation of 5.0cm and stride length .8m (80 cm) would have a
+ * vertical ratio of 0.625.
*/
@JvmField
val VERTICAL_RATIO: DeltaDataType<Double, SampleDataPoint<Double>> =
createSampleDataType("Vertical Ratio")
/**
- * Statistics on vertical oscillation / stride length. Divide vertical oscillation
- * (converted to meters) by stride length (in meters) in `double` format.
+ * Statistics on vertical oscillation / stride length.
+ *
+ * For example, a vertical oscillation of 5.0cm and stride length .8m (80 cm) would have a
+ * vertical ratio of 0.625.
*/
@JvmField
val VERTICAL_RATIO_STATS: AggregateDataType<Double, StatisticalDataPoint<Double>> =
