Skip to content

Commit

Permalink
Fix typos in RELEASE.md and account.md documentation #433 (#440)
Browse files Browse the repository at this point in the history
### Description

Corrected minor spelling errors in documentation files. These changes
improve the clarity and accuracy of the content.



#### Other changes

Fixed the typo in the RELEASE.md file: corrected "significant" to the
correct spelling.
Fixed the typo in the docs/command-line-interface/account.md file:
corrected "beneficary" to "beneficiary".

### Related issues

- replaces #433 -- some of our ci seems to not run on forked requests
namely foundry


<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on correcting typographical errors related to the word
"beneficiary" across various files, ensuring consistency and clarity in
documentation and code comments.

### Detailed summary
- Corrected "benficiary" to "beneficiary" in comments and descriptions
in:
  - `packages/sdk/contractkit/src/wrappers/Accounts.ts`
  - `packages/cli/src/commands/account/register-data-encryption-key.ts`
  - `packages/cli/src/commands/account/delete-payment-delegation.ts`
  - `packages/sdk/explorer/fixtures/contract.metadata.json`
  - `docs/sdk/contractkit/classes/wrappers_Accounts.AccountsWrapper.md`
  - `RELEASE.md`
  - `docs/command-line-interface/account.md`

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

<!-- end pr-codex -->

---------

Co-authored-by: Cypher Pepe <[email protected]>
  • Loading branch information
aaronmgdr and cypherpepe authored Nov 18, 2024
1 parent 7826b08 commit 351a607
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Being assigned as the release steward means you are expected to deliver
* Release notes on github for every package (automatically created by changesets bot)
* If the release is significant a forum post with the highlights and link back to release notes

### What is a signicant release
### What is a significant release

This is intentionally not defined. Some guiding principles: if it has been a long time, if someone will be asking about the release, if there are big fixes.

Expand Down Expand Up @@ -45,7 +45,7 @@ require a patch, minor, or major update.

## Package Versioning

Based on [semantic versioning best practices](semver.org),g iven a version number
Based on [semantic versioning best practices](semver.org), given a version number
`MAJOR.MINOR.PATCH`, increment the:

- `MAJOR` version when you make incompatible API changes
Expand Down
6 changes: 3 additions & 3 deletions docs/command-line-interface/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ _See code: [src/commands/account/deauthorize.ts](https://github.com/celo-org/dev

## `celocli account:delete-payment-delegation`

Removes a validator's payment delegation by setting benficiary and fraction to 0.
Removes a validator's payment delegation by setting beneficiary and fraction to 0.

```
USAGE
Expand All @@ -405,7 +405,7 @@ FLAGS
flags
DESCRIPTION
Removes a validator's payment delegation by setting benficiary and fraction to 0.
Removes a validator's payment delegation by setting beneficiary and fraction to 0.
EXAMPLES
delete-payment-delegation --account 0x5409ED021D9299bf6814279A6A1411A7e866A631
Expand Down Expand Up @@ -825,7 +825,7 @@ USAGE
[--globalHelp]
FLAGS
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Addess of the
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the
account to set the data
encryption key for
--gasCurrency=0x1234567890123456789012345678901234567890 Use a specific gas currency
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,14 @@ ___

**deletePaymentDelegation**: (...`args`: []) => `CeloTransactionObject`\<`void`\>

Remove a validator's payment delegation by setting benficiary and
Remove a validator's payment delegation by setting beneficiary and
fraction to 0.

#### Type declaration

▸ (`...args`): `CeloTransactionObject`\<`void`\>

Remove a validator's payment delegation by setting benficiary and
Remove a validator's payment delegation by setting beneficiary and
fraction to 0.

##### Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { CustomFlags } from '../../utils/command'

export default class DeletePaymentDelegation extends BaseCommand {
static description =
"Removes a validator's payment delegation by setting benficiary and fraction to 0."
"Removes a validator's payment delegation by setting beneficiary and fraction to 0."

static flags = {
...BaseCommand.flags,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export default class RegisterDataEncryptionKey extends BaseCommand {
...BaseCommand.flags,
from: CustomFlags.address({
required: true,
description: 'Addess of the account to set the data encryption key for',
description: 'Address of the account to set the data encryption key for',
}),
publicKey: Flags.string({
required: true,
Expand Down
2 changes: 1 addition & 1 deletion packages/sdk/contractkit/src/wrappers/Accounts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ export class AccountsWrapper extends BaseWrapper<Accounts> {
setPaymentDelegation = proxySend(this.connection, this.contract.methods.setPaymentDelegation)

/**
* Remove a validator's payment delegation by setting benficiary and
* Remove a validator's payment delegation by setting beneficiary and
* fraction to 0.
*/
deletePaymentDelegation = proxySend(
Expand Down
2 changes: 1 addition & 1 deletion packages/sdk/explorer/fixtures/contract.metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2546,7 +2546,7 @@
"notice": "Creates an account."
},
"deletePaymentDelegation()": {
"notice": "Removes a validator's payment delegation by setting benficiary and fraction to 0."
"notice": "Removes a validator's payment delegation by setting beneficiary and fraction to 0."
},
"getAttestationSigner(address)": {
"notice": "Returns the attestation signer for the specified account."
Expand Down

0 comments on commit 351a607

Please sign in to comment.