1
0
Fork 0

Revert "chore: Linting for markdown and js"

This reverts commit 1c92e0f655.
This commit is contained in:
joostdecock 2021-10-17 18:26:00 +02:00
parent 994874fa72
commit cba1ab19c8
6627 changed files with 25791 additions and 24211 deletions

View file

@ -1,10 +1,9 @@
***
---
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

@ -1,10 +1,10 @@
***
---
title: Part.getId()
---
## title: Part.getId()
A part's `getId()` method will return an integer the can be used as an
A part's `getId()` method will return an integer the can be used as an
ID Points/Paths/Snippets. This method will ensure the ID is unique be
keeping an internal record of the ID that have been used.
keeping an internal record of the ID that have been used.
It is typically used when programatically adding points, paths, or snippets.
## Part.getId() signature
@ -30,3 +30,5 @@ export default function (part) {
return part
}
```

View file

@ -1,6 +1,6 @@
***
## title: Part.raise.debug()
---
title: Part.raise.debug()
---
A part's `raise.debug()` method will log a debug-level event.
Debug events are typically used to pass information to pattern developers
@ -35,3 +35,4 @@ export default function (part) {
return part
}
```

View file

@ -1,6 +1,6 @@
***
## title: Part raise methods
---
title: Part raise methods
---
A part's different `raise` methods are used to bring information to the attention
of the user, or developer. You can think of them as logging methods the register
@ -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,3 +62,4 @@ 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

@ -1,6 +1,6 @@
***
## title: Part.raise.error()
---
title: Part.raise.error()
---
A part's `raise.error()` method will log a error-level event.
Unlike other raised events which have no side-effects, if there is one or more
@ -32,3 +32,4 @@ export default function (part) {
}
}
```

View file

@ -1,6 +1,6 @@
***
## title: Part.raise.info()
---
title: Part.raise.info()
---
A part's `raise.info()` method will log a ingo-level event.
Info events are typically used to pass information to users

View file

@ -1,6 +1,6 @@
***
## title: Part.raise.warning()
---
title: Part.raise.warning()
---
A part's `raise.warning()` method will log a warning-level event.
Warning events are typically used to pass information to pattern developers
@ -41,3 +41,4 @@ export default function (part) {
return part
}
```

View file

@ -1,10 +1,10 @@
***
## title: Part.shorthand()
---
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.
@ -79,7 +79,8 @@ 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

@ -1,10 +1,10 @@
***
## title: Part.units()
---
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,3 +34,4 @@ export default function (part) {
raise.info(`Pattern drafted for a ${units(measurements.chest)} chest`)
}
```