From b5371f0b5ccb85897acc42b9b380d43f4170ed3c Mon Sep 17 00:00:00 2001 From: Benjamin F Date: Wed, 3 May 2023 18:48:32 -0700 Subject: [PATCH] fix(docs): Clarify how optional measurements are accessed --- .../dev/reference/api/part/config/measurements/en.md | 9 +++++++++ markdown/dev/reference/settings/measurements/en.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/markdown/dev/reference/api/part/config/measurements/en.md b/markdown/dev/reference/api/part/config/measurements/en.md index 3fbbf6aba7d..c3a0b1818f2 100644 --- a/markdown/dev/reference/api/part/config/measurements/en.md +++ b/markdown/dev/reference/api/part/config/measurements/en.md @@ -38,3 +38,12 @@ const part = { } ``` + + +Although they are specified via the part configuration `optionalMeasurements` +property, optional measurements are accessed via the 'measurements' +settings property. + +(There is no `optionalMeasurements` settings property.)` + + diff --git a/markdown/dev/reference/settings/measurements/en.md b/markdown/dev/reference/settings/measurements/en.md index ea77f5e54c8..6be38b0d1c4 100644 --- a/markdown/dev/reference/settings/measurements/en.md +++ b/markdown/dev/reference/settings/measurements/en.md @@ -39,3 +39,12 @@ const pattern = new Aaron({ Measurements should always be specified in millimeter, unless it's an angle measurement (like `shoulderSlope`) which should be provided in degrees. + + + +The `measurements` settings property is used to hold __all__ measurements, +both regular measurements as well as any optional measurements. + +(There is no `optionalMeasurements` settings property.) + +