Skip to content

Commit c6c50a4

Browse files
committed
docs: fix grammar, typos, and path errors in documentation
1 parent 4415bec commit c6c50a4

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Then, from the root folder run:
5555
- `yarn build` to build packages
5656
- `yarn test` to ensure that the test suite runs correctly
5757

58-
NOTE: Running `yarn test` currently fails due to an environment issue with shuttle. you can still run `yarn test` successfully from all the other repositories.
58+
NOTE: Running `yarn test` currently fails due to an environment issue with shuttle. You can still run `yarn test` successfully from all the other repositories.
5959

6060
### 2.2 Signing Commits
6161

@@ -150,7 +150,7 @@ const parseMessage = (message: string): HubResult<Uint8Array> => {
150150

151151
---
152152

153-
Always wrap external calls with `Result.fromThrowable` or `ResultAsync.fromPromise` and wrap external an `Error` into a `HubError`.
153+
Always wrap external calls with `Result.fromThrowable` or `ResultAsync.fromPromise` and wrap an external `Error` into a `HubError`.
154154

155155
```ts
156156
// incorrect usage

packages/hub-nodejs/docs/Builders.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Before you can build messages, you'll need to construct the following objects:
2727

2828
### Ed25519Signer
2929

30-
A Ed25519Signer is an EdDSA key pair which is necessary for signing most messages on behalf of an fid. This example below shows how to construct a new `NobleEd25519Signer` using the [@noble](https://paulmillr.com/noble/) library:
30+
An Ed25519Signer is an EdDSA key pair which is necessary for signing most messages on behalf of an fid. This example below shows how to construct a new `NobleEd25519Signer` using the [@noble](https://paulmillr.com/noble/) library:
3131

3232
```typescript
3333
import { NobleEd25519Signer } from '@farcaster/hub-nodejs';
@@ -40,7 +40,7 @@ const ed25519Signer = new NobleEd25519Signer(privateKey);
4040

4141
### Eip712Signer
4242

43-
An Eip712Signer is an ECDSA key pair that is necessary signing for some messages like `SignerAdds` and `Verifications`. This example shows how to construct an `EthersEip712Signer` from a wallet's recovery phrase:
43+
An Eip712Signer is an ECDSA key pair that is necessary for signing some messages like `SignerAdds` and `Verifications`. This example shows how to construct an `EthersEip712Signer` from a wallet's recovery phrase:
4444

4545
```typescript
4646
import { EthersEip712Signer } from '@farcaster/hub-nodejs';

packages/hub-nodejs/examples/hello-world/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ You can try out a web version of this at https://farcaster-signup-demo-wkulikows
1818
### Run locally
1919

2020
1. Clone the repo locally
21-
2. Navigate to this folder with `cd packages/hub-nodejs/examples/write-data`
21+
2. Navigate to this folder with `cd packages/hub-nodejs/examples/hello-world`
2222
3. Run `yarn install` to install dependencies
2323
4. Run `yarn start`

packages/hub-nodejs/examples/write-data/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Writing Data to Hubs
22

3-
An example that different types of messages like casts, reactions, follows, etc. given a signer private key for an fid.
3+
An example that writes different types of messages like casts, reactions, follows, etc. given a signer private key for an fid.
44

55
The example runs on testnet by default so that you can make changes safely without affecting your mainnet data.
66

0 commit comments

Comments
 (0)