1
0
Fork 0

fix(docs): Update and correct Pattern documentation

This commit is contained in:
Benjamin F 2022-12-08 20:40:31 -08:00
parent 3a15f7a730
commit ee162bf99a
5 changed files with 14 additions and 12 deletions

View file

@ -71,9 +71,11 @@ It just so happens that in most cases, there will be only one settings object in
- `Pattern.activePart`: Holds the id of the active part (while drafting)
- `Pattern.activeSet`: Holds the id of the active set (while drafting)
- `Pattern.designConfig`: Holds the design's configuration
- `Pattern.designConfig`: Holds the design's configuration
- `Pattern.patternConfig`: Holds the pattern's configuration
- `Pattern.config`: Holds the resolved pattern's configuration
- `Pattern.designConfig`: Holds the design's configuration before resolution
- `Pattern.parts`: Holds the parts used in the pattern
- `Pattern.plugins`: Holds the plugins used in the pattern
- `Pattern.settings`: Holds the settings used for the pattern
- `Pattern.store`: Holds the pattern-wide Store
- `Pattern.setStores`: Holds an array of stores, one for each set of settings.

View file

@ -10,7 +10,7 @@ housekeeping tasks that are typically done behind the scenes when you call
return a Pattern's internal configuration.
You can use this to see what options a pattern provides, what
measurments it requires, and so on.
measurements it requires, and so on.
## Pattern.getConfig() signature

View file

@ -18,7 +18,7 @@ Pattern pattern.on(string hook, function method)
<Tip>
Refer to [the Lifecycle hooks documentation](/reference/hooks/) for a list
of all avaialble lifecycle hooks, as well as the signature of the function you
of all availalble lifecycle hooks, as well as the signature of the function you
should pass it.
</Tip>

View file

@ -9,9 +9,9 @@ top of each other.
<Note>This method is chainable as it returns the Pattern object</Note>
Under the hood, this method will call one of
[Pattern.sampleOption()](/reference/apu/pattern/sampleoption),
[Pattern.sampleMeasurement()](/reference/apu/pattern/sampleoption), or
[Pattern.sampleModels()](/reference/apu/pattern/sampleoption) to sample
[Pattern.sampleOption()](/reference/api/pattern/sampleoption),
[Pattern.sampleMeasurement()](/reference/api/pattern/samplemeasurement), or
[Pattern.sampleModels()](/reference/api/pattern/samplemodels) to sample
an option, a measurement, or different models respectively.
Unlike those three methods where you pass the relevant info to to the method,
@ -27,9 +27,9 @@ The `settings.sample` object can hold the following properties:
See the specific sample methods below for more details:
- [Pattern.sampleOption()](/reference/apu/pattern/sampleoption)
- [Pattern.sampleMeasurement()](/reference/apu/pattern/sampleoption)
- [Pattern.sampleModels()](/reference/apu/pattern/sampleoption)
- [Pattern.sampleOption()](/reference/api/pattern/sampleoption)
- [Pattern.sampleMeasurement()](/reference/api/pattern/samplemeasurement)
- [Pattern.sampleModels()](/reference/api/pattern/samplemodels)
## Pattern.sample() signature

View file

@ -57,5 +57,5 @@ import { cisFemaleAdult } from "@freesewing/models"
const Aaron = new Aaron()
const svg = aaron.sampleModels(cisFemaleAdult, "34').render()
const svg = aaron.sampleModels(cisFemaleAdult, "34").render()
```