Skip to content

Commit

Permalink
fix: correct project typos (#4102)
Browse files Browse the repository at this point in the history
* fix: correct typos in connector request yml

* fix: correct typo in core changelog

* fix: correct typo in  core action description comment

* fix: correct typo in vitepress theme description comment

* fix: correct typos in site docs

* revert: changes of intentional typos
  • Loading branch information
ClumsyVlad committed Jul 2, 2024
1 parent 4f008a6 commit 4e9493a
Show file tree
Hide file tree
Showing 18 changed files with 25 additions and 25 deletions.
8 changes: 4 additions & 4 deletions .github/DISCUSSION_TEMPLATE/connector-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ body:
value: |
Thanks for your interest in contributing a new Connector to the Wagmi! If you haven't already, please read the [Contributing Guidelines](https://wagmi.sh/dev/contributing). Once you submit the form, the Wagmi team will follow up in the discussion thread to discuss next steps.
Please note that in order for connector requests to be accepted, the team creating the connector must [sponsor Wagmi](https://github.com/sponsors/wevm). It takes time and effort to maintain third-party connectors. Wagmi is an OSS project that depends on sponsors and grants to continue our work. Please get in touch via [dev@wevm.dev](mailto:dev@wevm.dev) if you have questions about sponsoring.
Please note that in order for connector requests to be accepted, the team creating the Connector must [sponsor Wagmi](https://github.com/sponsors/wevm). It takes time and effort to maintain third-party connectors. Wagmi is an OSS project that depends on sponsors and grants to continue our work. Please get in touch via [dev@wevm.dev](mailto:dev@wevm.dev) if you have questions about sponsoring.
- type: textarea
attributes:
Expand All @@ -31,15 +31,15 @@ body:
- type: textarea
attributes:
label: Are the Connector's integrations production-ready and generally available?
description: Connectors are intended to be used by consumers in production as part of Wagmi. As such, the connector and all dependencies must be production-ready and generally available. This means your connector should not rely on non-production software or be restricted to a limited group of users. For example, if your connector requires a wallet that has a closed beta, it is not ready for inclusion in Wagmi.
description: Connectors are intended to be used by consumers in production as part of Wagmi. As such, the Connector and all dependencies must be production-ready and generally available. This means your connector should not rely on non-production software or be restricted to a limited group of users. For example, if your connector requires a wallet that has a closed beta, it is not ready for inclusion in Wagmi.
placeholder: Info about the Connector and any dependencies (e.g. browser extension, wallet app, npm package).
validations:
required: true

- type: checkboxes
attributes:
label: Are you committed to actively mainting the Connector?
description: It is critical connectors are updated in a timely manner and actively maintained so that users of Wagmi can rely on them in production settings. The Wagmi core team will provide as much assistance as possible to keep connectors up-to-date with breaking changes from Wagmi, but it is your responsibility to ensure that any dependencies and issues/discussions related to the connector are handled in a timely manner. If this is not done, the connector could be removed from the future versions.
label: Are you committed to actively maintaining the Connector?
description: It is critical connectors are updated in a timely manner and actively maintained so that users of Wagmi can rely on them in production settings. The Wagmi core team will provide as much assistance as possible to keep connectors up-to-date with breaking changes from Wagmi, but it is your responsibility to ensure that any dependencies and issues/discussions related to the Connector are handled in a timely manner. If this is not done, the Connector could be removed from the future versions.
options:
- label: Yes, my team is or I am committed to actively maintaining the Connector.
required: true
Expand Down
2 changes: 1 addition & 1 deletion packages/core/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -741,7 +741,7 @@

- **Breaking:** Renamed `createClient` to `createConfig`
- **Breaking:** Renamed `getClient` to `getConfig`
- **Breaking:** Removed `request` as an argument to `prepareSendTransaction` & `sendTransation`. Arguments now belong on the root level of the Action.
- **Breaking:** Removed `request` as an argument to `prepareSendTransaction` & `sendTransaction`. Arguments now belong on the root level of the Action.

### Patch Changes

Expand Down
2 changes: 1 addition & 1 deletion site/.vitepress/theme/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* custom containers.
*
* - `default`: The color used purely for subtle indication without any
* special meanings attched to it such as bg color for menu hover state.
* special meanings attached to it such as bg color for menu hover state.
*
* - `brand`: Used for primary brand colors, such as link text, button with
* brand theme, etc.
Expand Down
2 changes: 1 addition & 1 deletion site/core/api/actions/verifyMessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ import { type VerifyMessageReturnType } from '@wagmi/core'

`boolean`

Wheather the signed message is valid for the given address.
Whether the signed message is valid for the given address.

## Error

Expand Down
2 changes: 1 addition & 1 deletion site/core/api/actions/verifyTypedData.md
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@ import { type VerifyTypedDataReturnType } from '@wagmi/core'

`boolean`

Wheather the signed message is valid for the given address.
Whether the signed message is valid for the given address.

## Type Inference

Expand Down
4 changes: 2 additions & 2 deletions site/core/guides/chain-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Some chains support additional properties related to blocks and transactions. Th

## Narrowing Parameters

When you pass your `config` to an action, you are ready to access chain-specifc properties! For example, Celo's `feeCurrency` is available.
When you pass your `config` to an action, you are ready to access chain-specific properties! For example, Celo's `feeCurrency` is available.

::: code-group
```ts [index.ts]
Expand All @@ -21,7 +21,7 @@ const result = await simulateContract(config, {
<<< @/snippets/core/config-chain-properties.ts[config.ts]
:::

This is great, but if you have multiple chains that support additional properties, your autocomplete could be overwhelmed with all of them. By setting the `chainId` property to a specifc value (e.g. `celo.id`), you can narrow parameters to a single chain.
This is great, but if you have multiple chains that support additional properties, your autocomplete could be overwhelmed with all of them. By setting the `chainId` property to a specific value (e.g. `celo.id`), you can narrow parameters to a single chain.

::: code-group
```ts [index.ts]
Expand Down
2 changes: 1 addition & 1 deletion site/core/guides/migrate-from-v1-to-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ const result = await getEnsAddress(config, {
<<< @/snippets/core/config.ts[config.ts]
:::

By inverting control, Wagmi let's you choose how much normalization to do. For example, maybe your project only allows ENS names that are rcnumeric so no normalization is not needed. Check out the [ENS documentation](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) for more information on normalizing names.
By inverting control, Wagmi let's you choose how much normalization to do. For example, maybe your project only allows ENS names that are numeric so no normalization is not needed. Check out the [ENS documentation](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) for more information on normalizing names.

### Removed `configureChains`

Expand Down
2 changes: 1 addition & 1 deletion site/core/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Data layer performance is also critical. Slow, unnecessary, and manual data fetc

## Feature Coverage

Wagmi Core supports the most popular and commonly-used Ethereum features out of the box with 40+ VanillaJS Actions for accounts, wallets, contracts, transactions, signing, ENS, and more. Wagmi Core also supports just about any wallet out there through it's official [connectors](/core/api/connectors), [EIP-6963 support](/core/api/createConfig#multiinjectedproviderdiscovery), and [extensable API](/dev/creating-connectors).
Wagmi Core supports the most popular and commonly-used Ethereum features out of the box with 40+ VanillaJS Actions for accounts, wallets, contracts, transactions, signing, ENS, and more. Wagmi Core also supports just about any wallet out there through it's official [connectors](/core/api/connectors), [EIP-6963 support](/core/api/createConfig#multiinjectedproviderdiscovery), and [extensible API](/dev/creating-connectors).

If you need lower-level control, you can always drop down to [Viem](https://viem.sh), which Wagmi Core uses internally to perform blockchain operations. Wagmi Core also manages multi-chain support automatically so developers can focus on their applications instead of adding custom code.

Expand Down
2 changes: 1 addition & 1 deletion site/dev/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ After the install completes, pnpm links packages across the project for developm

## 4. Adding the env variables

The [dev playgrounds](#_5-running-the-dev-playgrounds) and [test suite](#_6-running-the-test-suite) require enironment variables to be set. Copy over the following environment variables to `.env`, and fill them out.
The [dev playgrounds](#_5-running-the-dev-playgrounds) and [test suite](#_6-running-the-test-suite) require environment variables to be set. Copy over the following environment variables to `.env`, and fill them out.

```bash
VITE_MAINNET_FORK_URL=https://cloudflare-eth.com
Expand Down
4 changes: 2 additions & 2 deletions site/react/guides/chain-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Make sure you follow the TypeScript guide's [Config Types](/react/typescript#con

## Narrowing Parameters

Once your Config is registered with TypeScript, you are ready to access chain-specifc properties! For example, Celo's `feeCurrency` is available.
Once your Config is registered with TypeScript, you are ready to access chain-specific properties! For example, Celo's `feeCurrency` is available.

::: code-group
```ts [index.tsx]
Expand All @@ -28,7 +28,7 @@ const result = useSimulateContract({
<<< @/snippets/react/config-chain-properties.ts[config.ts]
:::

This is great, but if you have multiple chains that support additional properties, your autocomplete could be overwhelmed with all of them. By setting the `chainId` property to a specifc value (e.g. `celo.id`), you can narrow parameters to a single chain.
This is great, but if you have multiple chains that support additional properties, your autocomplete could be overwhelmed with all of them. By setting the `chainId` property to a specific value (e.g. `celo.id`), you can narrow parameters to a single chain.

::: code-group
```ts [index.tsx]
Expand Down
2 changes: 1 addition & 1 deletion site/react/guides/migrate-from-v1-to-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ const result = useEnsAddress({
})
```

By inverting control, Wagmi let's you choose how much normalization to do. For example, maybe your project only allows ENS names that are rcnumeric so no normalization is not needed. Check out the [ENS documentation](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) for more information on normalizing names.
By inverting control, Wagmi let's you choose how much normalization to do. For example, maybe your project only allows ENS names that are numeric so no normalization is not needed. Check out the [ENS documentation](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) for more information on normalizing names.

### Removed `configureChains`

Expand Down
4 changes: 2 additions & 2 deletions site/react/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Data layer performance is also critical. Slow, unnecessary, and manual data fetc

## Feature Coverage

Wagmi supports the most popular and commonly-used Ethereum features out of the box with 40+ React Hooks for accounts, wallets, contracts, transactions, signing, ENS, and more. Wagmi also supports just about any wallet out there through it's official [connectors](/react/api/connectors), [EIP-6963 support](/react/api/createConfig#multiinjectedproviderdiscovery), and [extensable API](/dev/creating-connectors).
Wagmi supports the most popular and commonly-used Ethereum features out of the box with 40+ React Hooks for accounts, wallets, contracts, transactions, signing, ENS, and more. Wagmi also supports just about any wallet out there through it's official [connectors](/react/api/connectors), [EIP-6963 support](/react/api/createConfig#multiinjectedproviderdiscovery), and [extensible API](/dev/creating-connectors).

If you need lower-level control, you can always drop down to [Wagmi Core](/core/getting-started) or [Viem](https://viem.sh), which Wagmi uses internally to perform blockchain operations. Wagmi also manages multi-chain support automatically so developers can focus on their applications instead of adding custom code.

Expand All @@ -38,7 +38,7 @@ Finally, Wagmi has a [CLI](/cli/getting-started) to manage ABIs as well as a rob

Stability is a fundamental principle for Wagmi. Many organizations, large and small, rely heavily on Wagmi and expect it to be entirely stable for their users and applications.

Wagmi's test suite runs against forked Ethereum nodes to make sure functions work across chains. The test suite also runs type tests against many different versions of peer dependencies, like TypeScript, to ensure compatbility with the latest releases of other popular software.
Wagmi's test suite runs against forked Ethereum nodes to make sure functions work across chains. The test suite also runs type tests against many different versions of peer dependencies, like TypeScript, to ensure compatibility with the latest releases of other popular software.

Wagmi follows semver so developers can upgrade between versions with confidence. Starting with Wagmi v2, new functionality will be opt-in with old functionality being deprecated alongside the new features. This means upgrading to the latest major versions will not require immediate changes.

Expand Down
2 changes: 1 addition & 1 deletion site/shared/createStorage.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ If you use a custom `deserialize` function, make sure it can handle `bigint` and
`string | undefined`

- Key prefix to use when persisting data.
- Detaults to `'wagmi'`.
- Defaults to `'wagmi'`.

```ts-vue
import { createStorage } from '{{packageName}}'
Expand Down
2 changes: 1 addition & 1 deletion site/shared/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Yes. Wagmi is very stable and is used in production by thousands of organization

Yes, Wagmi is very strict with [semantic versioning](https://semver.org) and we will never introduce breaking changes to the runtime API in a minor version bump.

For exported types, we try our best to not introduce breaking changes in non-major verions, however, [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) and often introduces breaking changes in minor releases that can cause Wagmi type issues. See the <a :href="`/${docsPath}/typescript#requirements`">TypeScript docs</a> for more information.
For exported types, we try our best to not introduce breaking changes in non-major versions, however, [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) and often introduces breaking changes in minor releases that can cause Wagmi type issues. See the <a :href="`/${docsPath}/typescript#requirements`">TypeScript docs</a> for more information.

## How can I contribute to Wagmi?

Expand Down
2 changes: 1 addition & 1 deletion site/shared/utilities/deserialize.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const result = deserialize('{"foo":"wagmi","bar":{"__type":"bigint","value":"123

`string`

The string to deserialze.
The string to deserialize.


### reviver
Expand Down
2 changes: 1 addition & 1 deletion site/vue/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const viemVersion = packageJson.peerDependencies.viem

## Overview

Wagmi is a collection of Vue composition utilties for Ethereum. You can learn more about the rationale behind the project in the [Why Wagmi](/vue/why) section.
Wagmi is a collection of Vue composition utilities for Ethereum. You can learn more about the rationale behind the project in the [Why Wagmi](/vue/why) section.

## Automatic Installation

Expand Down
4 changes: 2 additions & 2 deletions site/vue/guides/chain-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Make sure you follow the TypeScript guide's [Config Types](/vue/typescript#confi

## Narrowing Parameters

Once your Config is registered with TypeScript, you are ready to access chain-specifc properties! For example, Celo's `feeCurrency` is available.
Once your Config is registered with TypeScript, you are ready to access chain-specific properties! For example, Celo's `feeCurrency` is available.

::: code-group
```ts [index.tsx]
Expand All @@ -28,7 +28,7 @@ const result = useSimulateContract({
<<< @/snippets/vue/config-chain-properties.ts[config.ts]
:::

This is great, but if you have multiple chains that support additional properties, your autocomplete could be overwhelmed with all of them. By setting the `chainId` property to a specifc value (e.g. `celo.id`), you can narrow parameters to a single chain.
This is great, but if you have multiple chains that support additional properties, your autocomplete could be overwhelmed with all of them. By setting the `chainId` property to a specific value (e.g. `celo.id`), you can narrow parameters to a single chain.

::: code-group
```ts [index.tsx]
Expand Down
2 changes: 1 addition & 1 deletion site/vue/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Data layer performance is also critical. Slow, unnecessary, and manual data fetc

## Feature Coverage

Wagmi supports the most popular and commonly-used Ethereum features out of the box with 40+ Vue Composables for accounts, wallets, contracts, transactions, signing, ENS, and more. Wagmi also supports just about any wallet out there through it's official [connectors](/vue/api/connectors), [EIP-6963 support](/vue/api/createConfig#multiinjectedproviderdiscovery), and [extensable API](/dev/creating-connectors).
Wagmi supports the most popular and commonly-used Ethereum features out of the box with 40+ Vue Composables for accounts, wallets, contracts, transactions, signing, ENS, and more. Wagmi also supports just about any wallet out there through it's official [connectors](/vue/api/connectors), [EIP-6963 support](/vue/api/createConfig#multiinjectedproviderdiscovery), and [extensible API](/dev/creating-connectors).

If you need lower-level control, you can always drop down to [Wagmi Core](/core/getting-started) or [Viem](https://viem.sh), which Wagmi uses internally to perform blockchain operations. Wagmi also manages multi-chain support automatically so developers can focus on their applications instead of adding custom code.

Expand Down

0 comments on commit 4e9493a

Please sign in to comment.