Skip to content

Commit

Permalink
docs: Readme should not say 'mixin' twice in a row
Browse files Browse the repository at this point in the history
  • Loading branch information
ntucker committed Oct 13, 2024
1 parent 5a5c95f commit 25be07f
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 8 deletions.
8 changes: 8 additions & 0 deletions .changeset/early-tools-drum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
'@data-client/normalizr': patch
'@data-client/graphql': patch
'@data-client/react': patch
'@data-client/rest': patch
---

Update README to not say 'mixin' twice
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ For the small price of 9kb gziped.    [🏁Get started now](https://da

### Reactive Applications

- Rendering: [useSuspense()](https://dataclient.io/docs/api/useSuspense), [useLive()](https://dataclient.io/docs/api/useLive), [useCache()](https://dataclient.io/docs/api/useCache), [useDLE()](https://dataclient.io/docs/api/useDLE), [useQuery()](https://dataclient.io/docs/api/useQuery)
- Rendering: [useSuspense()](https://dataclient.io/docs/api/useSuspense), [useLive()](https://dataclient.io/docs/api/useLive), [useCache()](https://dataclient.io/docs/api/useCache), [useDLE()](https://dataclient.io/docs/api/useDLE), [useQuery()](https://dataclient.io/docs/api/useQuery), [useLoading()](https://dataclient.io/docs/api/useLoading), [useDebounce()](https://dataclient.io/docs/api/useDebounce), [useCancelling()](https://dataclient.io/docs/api/useCancelling)
- Event handling: [useController()](https://dataclient.io/docs/api/useController) returns [Controller](https://dataclient.io/docs/api/Controller)
<table>
<thead>
Expand Down
2 changes: 1 addition & 1 deletion docs/rest/api/Entity.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Entities are bound to Endpoints using [resource.schema](./resource.md#schema) or

:::tip

If you already have your classes defined, [EntityMixin](./EntityMixin.md) mixin can also be
If you already have your classes defined, [EntityMixin](./EntityMixin.md) can also be
used to make Entities.

:::
Expand Down
4 changes: 2 additions & 2 deletions docs/rest/api/EntityMixin.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import TypeScriptEditor from '@site/src/components/TypeScriptEditor';

`Entity` defines a single _unique_ object.

If you already have classes for your data-types, `EntityMixin` mixin may be for you.
If you already have classes for your data-types, `EntityMixin` may be for you.

<TypeScriptEditor>

Expand Down Expand Up @@ -94,7 +94,7 @@ Specifies the [Entity.schema](./Entity.md#schema)

## Methods

`EntityMixin` mixin has the same [methods as the Entity](./Entity.md#lifecycle) class.
`EntityMixin` has the same [methods as the Entity](./Entity.md#lifecycle) class.

## const vs class

Expand Down
2 changes: 1 addition & 1 deletion packages/graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ return <ReviewForm onSubmit={data => controller.fetch(createReview, data)} />;
<tbody><tr>
<td rowSpan="4"><a href="https://en.wikipedia.org/wiki/Object_(computer_science)">Object</a></td>
<td align="center">✅</td>
<td><a href="https://dataclient.io/rest/api/Entity">Entity</a>, <a href="https://dataclient.io/rest/api/EntityMixin">EntityMixin</a> mixin, <a href="https://dataclient.io/graphql/api/GQLEntity">GQLEntity</a></td>
<td><a href="https://dataclient.io/rest/api/Entity">Entity</a>, <a href="https://dataclient.io/rest/api/EntityMixin">EntityMixin</a>, <a href="https://dataclient.io/graphql/api/GQLEntity">GQLEntity</a></td>
<td>single <em>unique</em> object</td>
<td align="center">✅</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion packages/normalizr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Available from [@data-client/endpoint](https://www.npmjs.com/package/@data-clien
<tbody><tr>
<td rowSpan="4"><a href="https://en.wikipedia.org/wiki/Object_(computer_science)">Object</a></td>
<td align="center">✅</td>
<td><a href="https://dataclient.io/rest/api/Entity">Entity</a>, <a href="https://dataclient.io/rest/api/EntityMixin">EntityMixin</a> mixin</td>
<td><a href="https://dataclient.io/rest/api/Entity">Entity</a>, <a href="https://dataclient.io/rest/api/EntityMixin">EntityMixin</a></td>
<td>single <em>unique</em> object</td>
<td align="center">✅</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ For the small price of 9kb gziped. &nbsp;&nbsp; [🏁Get started now](https://da

## API

- Rendering: [useSuspense()](https://dataclient.io/docs/api/useSuspense), [useLive()](https://dataclient.io/docs/api/useLive), [useCache()](https://dataclient.io/docs/api/useCache), [useDLE()](https://dataclient.io/docs/api/useDLE), [useQuery()](https://dataclient.io/docs/api/useQuery)
- Rendering: [useSuspense()](https://dataclient.io/docs/api/useSuspense), [useLive()](https://dataclient.io/docs/api/useLive), [useCache()](https://dataclient.io/docs/api/useCache), [useDLE()](https://dataclient.io/docs/api/useDLE), [useQuery()](https://dataclient.io/docs/api/useQuery), [useLoading()](https://dataclient.io/docs/api/useLoading), [useDebounce()](https://dataclient.io/docs/api/useDebounce), [useCancelling()](https://dataclient.io/docs/api/useCancelling)
- Event handling: [useController()](https://dataclient.io/docs/api/useController) returns [Controller](https://dataclient.io/docs/api/Controller)
- [ctrl.fetch](https://dataclient.io/docs/api/Controller#fetch)
- [ctrl.fetchIfStale](https://dataclient.io/docs/api/Controller#fetchIfStale)
Expand Down
2 changes: 1 addition & 1 deletion packages/rest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ supports inferring argument types from the path templates.
<tbody><tr>
<td rowSpan="4"><a href="https://en.wikipedia.org/wiki/Object_(computer_science)">Object</a></td>
<td align="center">✅</td>
<td><a href="https://dataclient.io/rest/api/Entity">Entity</a>, <a href="https://dataclient.io/rest/api/EntityMixin">EntityMixin</a> mixin</td>
<td><a href="https://dataclient.io/rest/api/Entity">Entity</a>, <a href="https://dataclient.io/rest/api/EntityMixin">EntityMixin</a></td>
<td>single <em>unique</em> object</td>
<td align="center">✅</td>
</tr>
Expand Down

0 comments on commit 25be07f

Please sign in to comment.