VSinerva/freesewing
1
0
Fork 0
Code Activity

Merge pull request #4089 from BenJamesBen/optionalMeasurements-docs-update

Browse source 
fix(docs): Move optional measurements info from Part config to Part draft
This commit is contained in:
Joost De Cock 2023-10-14 16:47:27 +02:00 • committed by GitHub
commit 304b1f8ea0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

10
markdown/dev/reference/api/part/config/measurements/en.md
View file

@ -37,13 +37,3 @@ const part = {
draft: ({ part }) => part draft: ({ part }) => part
} }
``` ```
<Tip>
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.)`
</Tip>

12
markdown/dev/reference/api/part/draft/en.md
View file

@ -3,14 +3,14 @@ title: "The part's draft method"
--- ---
Each part **must** have a `draft` property that holds a method that will draft the part. Each part **must** have a `draft` property that holds a method that will draft the part.
In other words, this method is where the actual work happens. The method's signature In other words, this method is where the actual work happens. The method's signature
is as follows: is as follows:
```js ```js
function draft(props) function draft(props)
``` ```
The draft method receives a single parameter, an object which you can _destructure_ to The draft method receives a single parameter, an object which you can _destructure_ to
access the following properties: access the following properties:
| Property | Description | | Property | Description |
@ -45,3 +45,11 @@ access the following properties:
| `Bezier` | The [bezier-js](https://pomax.github.io/bezierjs/) library's `Bezier` named export | | `Bezier` | The [bezier-js](https://pomax.github.io/bezierjs/) library's `Bezier` named export |
|| **_Return value_** | || **_Return value_** |
| `part` | Your draft method **must** return this | | `part` | Your draft method **must** return this |
<Tip>
Please note that there is no `optionalMeasurements` property.
Instead, optional measurements are accessed via the 'measurements'
property.
</Tip>