1
0
Fork 0

chore(markdown): Linting of dev docs

This commit is contained in:
Joost De Cock 2022-02-19 08:04:25 +01:00
parent 1d8beedd44
commit 265ad404da
317 changed files with 1281 additions and 1503 deletions

View file

@ -3,7 +3,7 @@ title: Part
order: 20
---
The `Part` object in FreeSewing's core library holds all data and logic of a pattern part.
The `Part` object in FreeSewing's core library holds all data and logic of a pattern part.
A pattern part is what holds the actual information about points and paths,
and multiple parts together typically make up a pattern.

View file

@ -30,5 +30,3 @@ export default function (part) {
return part
}
```

View file

@ -35,4 +35,3 @@ export default function (part) {
return part
}
```

View file

@ -15,7 +15,7 @@ roadmap](https://github.com/freesewing/freesewing/discussions/1278) for details.
</Warning>
There are four different types of information with their own method:
There are four different types of information with their own method:
<ReadMore list />
@ -32,13 +32,13 @@ events: {
Calling the relevant `raise` method will add the data you pass to it to the relevant array.
For example, if we use:
For example, if we use:
```js
raise.info('Hello')
```
The result will be:
The result will be:
```js
events: {
@ -62,4 +62,3 @@ But if an error is raised, core won't attempt to pack the pattern parts on the p
In other words, it will abort after the draft, and not provide a layout.
</Note>

View file

@ -32,4 +32,3 @@ export default function (part) {
}
}
```

View file

@ -41,4 +41,3 @@ export default function (part) {
return part
}
```

View file

@ -4,7 +4,7 @@ title: Part.shorthand()
A part's `shorthand()` method provides easy access to a number of
internal objects and properties. It does so be returning an object
that contains all you need to draft your pattern parts. It is
that contains all you need to draft your pattern parts. It is
typically combined with object destructuring to pull out those
properties you need.
@ -80,8 +80,7 @@ paths.example = new Path()
<Tip>
As you can see in the example above, you can/should load only
As you can see in the example above, you can/should load only
the shorthand you need by using object destructuring.
</Tip>

View file

@ -4,7 +4,7 @@ title: Part.units()
A part's `units()` method will formats a float you pass it, which should
represent a value in mm, into the units requested by the user.
The returned value is to be used in presentation only, as it will be
The returned value is to be used in presentation only, as it will be
a string that includes the user's units.
<Tip>
@ -34,4 +34,3 @@ export default function (part) {
raise.info(`Pattern drafted for a ${units(measurements.chest)} chest`)
}
```