Skip to content

Commit

Permalink
Fix grammatical errors and typo in code (#2411)
Browse files Browse the repository at this point in the history
Fixed:

Changed "Commands must" to "Commands must be" for grammatical
correctness.
Corrected "import { geSSLHubRpcClient" to "import { getSSLHubRpcClient"
to fix the typo.
Why it's useful:
These changes fix grammatical errors and a typo, ensuring the code is
syntactically correct and easier to read.

<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on correcting a typo in the documentation and updating a
function name in the code.

### Detailed summary
- In `apps/hubble/www/docs/docs/cli.md`, the phrase "Commands must
invoked" was corrected to "Commands must be invoked".
- In `packages/hub-nodejs/docs/Client.md`, the function name
`geSSLHubRpcClient` was updated to `getSSLHubRpcClient`.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`

<!-- end pr-codex -->
  • Loading branch information
Danyylka authored Dec 7, 2024
1 parent 686aeb7 commit dc34dc8
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion apps/hubble/www/docs/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Documentation for the Hubble CLI.
5. `profile` - profile the storage usage of the db.
6. `console` - start an interactive repl console for debugging.

Commands must invoked with yarn by running:
Commands must be invoked with yarn by running:

```
# if using docker
Expand Down
2 changes: 1 addition & 1 deletion packages/hub-nodejs/docs/Client.md
Original file line number Diff line number Diff line change
Expand Up @@ -529,7 +529,7 @@ Returns all active casts that are replies to a specific cast in reverse chronolo
#### Usage

```typescript
import { geSSLHubRpcClient, hexStringToBytes } from '@farcaster/hub-nodejs';
import { getSSLHubRpcClient, hexStringToBytes } from '@farcaster/hub-nodejs';

const hubRpcEndpoint = 'testnet1.farcaster.xyz:2283';
const client = getSSLHubRpcClient(hubRpcEndpoint);
Expand Down

0 comments on commit dc34dc8

Please sign in to comment.