From 614a3f8c9c16902dbe33576a7f81e5e1670db0f6 Mon Sep 17 00:00:00 2001 From: Benjamin F Date: Wed, 3 May 2023 20:43:13 -0700 Subject: [PATCH] fix(docs): Remove sample setting info from Pattern.sample() --- markdown/dev/reference/api/pattern/sample/en.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/markdown/dev/reference/api/pattern/sample/en.md b/markdown/dev/reference/api/pattern/sample/en.md index 4262344ad85..0a913110e93 100644 --- a/markdown/dev/reference/api/pattern/sample/en.md +++ b/markdown/dev/reference/api/pattern/sample/en.md @@ -15,16 +15,10 @@ Under the hood, this method will call one of an option, a measurement, or different models respectively. Unlike those three methods where you pass the relevant info to to the method, -this `Pattern.sample()` method will instead read the `settings.sample` +this `Pattern.sample()` method will instead read the +[`settings.sample`](/reference/settings/sample) object to determine what needs to be done. -The `settings.sample` object can hold the following properties: - -- **type**: One of `option`, `measurement`, or `models` -- **option**: An option name as defined in the pattern config file (only used when `type` is option). -- **measurement**: A measurement name as defined in the pattern config file (only used when `type` is measurement). -- **models**: A plain object of different models where the key is the model name and the value an object with the required measurements. - See the specific sample methods below for more details: - [Pattern.sampleOption()](/reference/api/pattern/sampleoption)