chore(docs): added eslint to lint documentation code blocks (#2920)

* docs: added rule for code length

* chore: fixes based on vale errors

* changed to use eslint

* fixes using eslint

* added github action for documentation eslint

* changed allowed max-length

* fixed incorrect heading level

* removed comment
This commit is contained in:
Shahed Nasser
2022-12-30 18:44:46 +02:00
committed by GitHub
parent 99add15fc3
commit d1b4b11ff6
67 changed files with 2611 additions and 1735 deletions
@@ -82,7 +82,7 @@ medusa.orders.claimOrders({
})
.catch(() => {
// an error occurred
});
})
```
</TabItem>
@@ -90,23 +90,23 @@ medusa.orders.claimOrders({
```tsx
fetch(`<SERVER_URL>/store/orders/batch/customer/token`, {
method: 'POST',
credentials: 'include',
method: "POST",
credentials: "include",
body: JSON.stringify({
order_ids: [
order_id,
],
}),
headers: {
'Content-Type': 'application/json'
}
"Content-Type": "application/json",
},
})
.then(() => {
//successful
// successful
})
.catch(() => {
//display an error to the customer
});
// display an error to the customer
})
```
</TabItem>
@@ -131,14 +131,14 @@ Then, you send a request to the Verify Claim Order endpoint:
```tsx
medusa.orders.confirmRequest({
token
token,
})
.then(() => {
// successful
})
.catch(() => {
// an error occurred
});
})
```
</TabItem>
@@ -146,21 +146,21 @@ medusa.orders.confirmRequest({
```tsx
fetch(`<SERVER_URL>/store/orders/customer/confirm`, {
method: 'POST',
credentials: 'include',
method: "POST",
credentials: "include",
body: JSON.stringify({
token
token,
}),
headers: {
'Content-Type': 'application/json'
}
"Content-Type": "application/json",
},
})
.then(() => {
//successful
// successful
})
.catch(() => {
//display an error to the customer
});
// display an error to the customer
})
```
</TabItem>