VSinerva/freesewing
1
0
Fork 0
Code Activity

fix(docs): Remove sample setting info from Pattern.sample()

Browse source
This commit is contained in:
Benjamin F 2023-05-03 20:43:13 -07:00
parent 1a48bfa16c
commit 614a3f8c9c
1 changed files with 2 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

10
markdown/dev/reference/api/pattern/sample/en.md
View file

@ -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)