From 25ff204330f5cb72f470b48d4bfb3532111f405a Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 27 Nov 2024 21:50:17 +0200 Subject: [PATCH] Fix misc. spelling issues in docs (#1083) * Update CHANGELOG.md * Update CONTRIBUTING.md * Update README.md --- CHANGELOG.md | 8 ++++---- CONTRIBUTING.md | 2 +- README.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f1df5ef5..05f1d9826 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -298,7 +298,7 @@ interface FeeDistribution { ### Added - `rpc.server.simulateTransaction` now supports an optional `stateChanges?: LedgerEntryChange[]` field ([#963](https://github.com/stellar/js-stellar-sdk/pull/963)): - * If `Before` is omitted, it constitutes a creation, if `After` is omitted, it constitutes a deletions, note that `Before` and `After` cannot be be omitted at the same time. Each item follows this schema: + * If `Before` is omitted, it constitutes a creation, if `After` is omitted, it constitutes a deletions, note that `Before` and `After` cannot be omitted at the same time. Each item follows this schema: ```typescript interface LedgerEntryChange { @@ -348,7 +348,7 @@ import { +import { Spec } from '@stellar/stellar-sdk/contract' ``` -- Previously, `AssembledTransaction.signAndSend()` would return a `SentTransaction` even if the transaction never finalized. That is, if it successfully sent the transaction to the network, but the transaction was still `status: 'PENDING'`, then it would `console.error` an error message, but return the indeterminate transaction anyhow. **It now throws** a `SentTransaction.Errors.TransactionStillPending` error with that error message instead ([#962](https://github.com/stellar/js-stellar-sdk/pull/962)). +- Previously, `AssembledTransaction.signAndSend()` would return a `SentTransaction` even if the transaction was never finalized. That is, if it successfully sent the transaction to the network, but the transaction was still `status: 'PENDING'`, then it would `console.error` an error message, but return the indeterminate transaction anyhow. **It now throws** a `SentTransaction.Errors.TransactionStillPending` error with that error message instead ([#962](https://github.com/stellar/js-stellar-sdk/pull/962)). ### Deprecated @@ -732,7 +732,7 @@ Refer to the release notes for the betas (e.g. [v9.0.0-beta.0](https://github.co ### Updates -- Updates the following SEP-10 utility functions to be compilant with the protocols ([#709](https://github.com/stellar/js-stellar-sdk/pull/709/), [stellar-protocol/#1036](https://github.com/stellar/stellar-protocol/pull/1036)) +- Updates the following SEP-10 utility functions to be compliant with the protocols ([#709](https://github.com/stellar/js-stellar-sdk/pull/709/), [stellar-protocol/#1036](https://github.com/stellar/stellar-protocol/pull/1036)) - Updated `utils.buildChallengeTx()` to accept muxed accounts (`M...`) for client account IDs - Updated `utils.buildChallengeTx()` to accept a `memo` parameter to attach to the challenge transaction - Updated `utils.readChallengeTx()` to provide a `memo` property in the returned object @@ -1052,7 +1052,7 @@ The following functions were renamed: - `xdr.OperationType.setOption()` -> `xdr.OperationType.setOptions()` - `xdr.OperationType.manageDatum()` -> `xdr.OperationType.manageData()` -The following enum values were rename in `OperationType`: +The following enum values were renamed in `OperationType`: - `setOption` -> `setOptions` - `manageDatum` -> `manageData` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6aa9d5f9..102142a27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,6 @@ In fact, you should follow [the steps there](https://github.com/stellar/js-stell } ``` - - [ ] Finally, run `yarn` so that the dependency is pulled (ensuring its a valid version) and the lockfile is updated with the latest integrity details. You can now commit the change and PR accordingly. + - [ ] Finally, run `yarn` so that the dependency is pulled (ensuring it's a valid version) and the lockfile is updated with the latest integrity details. You can now commit the change and PR accordingly. Note that new versions will be published to npm **and** Bower by GitHub Actions. diff --git a/README.md b/README.md index f5652b50b..073ca7b65 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ You can use a CDN: ``` -Note that this method relies using a third party to host the JS library. This may not be entirely secure. You can self-host it via [Bower](http://bower.io): +Note that this method relies on using a third party to host the JS library. This may not be entirely secure. You can self-host it via [Bower](http://bower.io): ```shell bower install @stellar/stellar-sdk